Skip to content

Commit 403199b

Browse files
SanMurakamiSanMurakami
authored
Merge pull request #47 from Ixy194194/dev
一旦マージ
2 parents f0148da + 13dc7da commit 403199b

38 files changed

+10719
-8535
lines changed

‎.editorconfig‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Editor configuration, see http://editorconfig.org
2+
root = true
3+
4+
[*]
5+
charset = utf-8
6+
indent_style = tab
7+
indent_size = 2
8+
insert_final_newline = true
9+
trim_trailing_whitespace = true
10+
11+
[*.md]
12+
max_line_length = off
13+
trim_trailing_whitespace = false

‎.eslintrc.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
{
2-
"extends": "next/core-web-vitals"
2+
"extends": ["next/core-web-vitals", "prettier"]
33
}

‎.github/workflows/nextjs.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ jobs:
4545
echo "runner=npx --no-install" >> $GITHUB_OUTPUT
4646
exit 0
4747
else
48-
echo "Unable to determine packager manager"
48+
echo "Unable to determine package manager"
4949
exit 1
5050
fi
5151
- name: Setup Node

‎.github/workflows/unittest.yaml‎

Lines changed: 37 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -1,40 +1,40 @@
11
name: UnitTest
22
on:
3-
push:
4-
branches-ignore:
5-
- main
6-
pull_request:
7-
branches-ignore:
8-
- main
3+
push:
4+
branches-ignore:
5+
- main
6+
pull_request:
7+
branches-ignore:
8+
- main
99
jobs:
10-
unit-testing:
11-
runs-on: ubuntu-latest
12-
steps:
13-
- name: Checkout
14-
uses: actions/checkout@v3
15-
- name: Detect package manager
16-
id: detect-package-manager
17-
run: |
18-
if [ -f "${{ github.workspace }}/yarn.lock" ]; then
19-
echo "manager=yarn" >> $GITHUB_OUTPUT
20-
echo "command=install" >> $GITHUB_OUTPUT
21-
echo "runner=yarn" >> $GITHUB_OUTPUT
22-
exit 0
23-
elif [ -f "${{ github.workspace }}/package.json" ]; then
24-
echo "manager=npm" >> $GITHUB_OUTPUT
25-
echo "command=ci" >> $GITHUB_OUTPUT
26-
echo "runner=npx --no-install" >> $GITHUB_OUTPUT
27-
exit 0
28-
else
29-
echo "Unable to determine packager manager"
30-
exit 1
31-
fi
32-
- name: Setup Node
33-
uses: actions/setup-node@v3
34-
with:
35-
node-version: "16"
36-
cache: ${{ steps.detect-package-manager.outputs.manager }}
37-
- name: Install dependencies
38-
run: ${{ steps.detect-package-manager.outputs.manager }} ${{ steps.detect-package-manager.outputs.command }}
39-
- name: Run Unit Test
40-
run: npm run test:ci
10+
unit-testing:
11+
runs-on: ubuntu-latest
12+
steps:
13+
- name: Checkout
14+
uses: actions/checkout@v3
15+
- name: Detect package manager
16+
id: detect-package-manager
17+
run: |
18+
if [ -f "${{ github.workspace }}/yarn.lock" ]; then
19+
echo "manager=yarn" >> $GITHUB_OUTPUT
20+
echo "command=install" >> $GITHUB_OUTPUT
21+
echo "runner=yarn" >> $GITHUB_OUTPUT
22+
exit 0
23+
elif [ -f "${{ github.workspace }}/package.json" ]; then
24+
echo "manager=npm" >> $GITHUB_OUTPUT
25+
echo "command=ci" >> $GITHUB_OUTPUT
26+
echo "runner=npx --no-install" >> $GITHUB_OUTPUT
27+
exit 0
28+
else
29+
echo "Unable to determine package manager"
30+
exit 1
31+
fi
32+
- name: Setup Node
33+
uses: actions/setup-node@v3
34+
with:
35+
node-version: "16"
36+
cache: ${{ steps.detect-package-manager.outputs.manager }}
37+
- name: Install dependencies
38+
run: ${{ steps.detect-package-manager.outputs.manager }} ${{ steps.detect-package-manager.outputs.command }}
39+
- name: Run Unit Test
40+
run: npm run test:ci

‎.prettierrc‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
{
2+
"trailingComma": "all",
3+
"tabWidth": 2,
4+
"semi": true,
5+
"singleQuote": true,
6+
"jsxSingleQuote": false,
7+
"printWidth": 100
8+
}

‎CONTRIBUTING.md‎

Lines changed: 95 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,95 @@
1+
# コントリビュートの流れ
2+
3+
開発は、[一般的な OSS コントリビューション](https://note.com/samurai_se/n/ncde3bb14066e?magazine_key=md5321f66534d)と同じ流れで行います。
4+
コントリビュートに際しての大まかな流れは以下の通りです。
5+
6+
## 1. このリポジトリをフォークします。
7+
8+
github の"Fork"から、自身のリポジトリに本家リポジトリを Fork してください。
9+
10+
## 2. 自分のリポジトリにフォークしたリポジトリをローカルにクローンします。
11+
12+
この作業は、誤ってオリジナルブランチへ push したりするのを防ぐために行います。
13+
14+
```
15+
git clone https://github.com/<あなたのユーザー名>/ixy-portfolio.git
16+
```
17+
18+
## 3. 本家リポジトリの URL を Upstream として登録します。
19+
20+
```sh
21+
git remote add upstream https://github.com/Ixy194194/ixy194194.github.io.git
22+
```
23+
24+
## 4. リポジトリのディレクトリに移動し、依存関係をインストールします。
25+
26+
```sh
27+
cd ixy194194.github.io
28+
npm install
29+
```
30+
31+
## 5. 開発サーバーを起動します。
32+
33+
```sh
34+
npm run dev
35+
# or
36+
yarn dev
37+
```
38+
39+
ブラウザで`http://localhost:3000`にアクセスすると、ウェブサイトが表示されます。**.tsx ファイル**を編集すると、ページが自動で更新されます。
40+
41+
ページを確認できたら、環境構築は完了です。
42+
43+
## 6. dev ブランチをベースに開発用ブランチを切ります。
44+
45+
```
46+
git branch <任意の名前(基本的にはissue番号)>
47+
```
48+
49+
## 7. 開発を進めていきます
50+
51+
開発を進めるにあたって、必ずテストコードも書いてコミット・push までしてください。
52+
既存のコードに新たな処理を追加した場合は、必ずテストコードも追加してください。
53+
新規でコードを作成した場合はいわずもがなテストコードも作成してください。
54+
55+
また、コミットを行う際には適切なプレフィックスをつけたコミットメッセージを書いてください。
56+
コミットメッセージの書き方は[こちら](https://qiita.com/konatsu_p/items/dfe199ebe3a7d2010b3e)を参考にしてください。
57+
58+
## 8. 開発が終わったら(できれば開発途中でも)、ローカルでテストコードを実行します
59+
60+
以下のコマンドを実行して、テストコードがエラーにならないかを確認してください。
61+
テスト駆動で開発を進めることが望ましいです。
62+
63+
また、コンポーネントを修正・追加した場合はテストコードも修正・追加してください。
64+
**test**フォルダにあるのがテストコードです。
65+
66+
テストコードはプルリクを出した場合にも実行されます。
67+
**そこでエラーがでないようにしてください。**
68+
69+
```sh
70+
npm run test
71+
# or
72+
npm run test:ci
73+
```
74+
75+
`npm run test` を実行した場合、ウォッチモードで実行されるためファイルを保存すると自動でユニットテストが実行されます。
76+
`npm run test:ci` を実行した場合、一度だけテストコードが実行されます。
77+
78+
## 9. プルリクを送る
79+
80+
プルリクのマージ先ブランチに**dev**を選択してください。
81+
先に issue を出していた場合は、プルリクのタイトルは「#issue 番号 issue 名」の形にしてください。
82+
issue を出していない場合、プルリクのタイトルは修正内容が分かる内容にしてください。
83+
84+
## 10. プルリクがマージされたら、自身のリポジトリに最新のソースを反映します。
85+
86+
オリジナルの dev への変更を自身のローカルの dev ブランチへ取り込み、自身のリモートリポジトリの dev ブランチへ反映させて、ソースを最新化します。
87+
88+
```sh
89+
git checkout dev
90+
git fetch upstream
91+
git merge upstream/dev --ff-only
92+
git push origin dev -u
93+
```
94+
95+
さらに開発を行う場合は、手順 6 へ戻ります。

‎README.md‎

Lines changed: 27 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -1,59 +1,50 @@
1-
# イラストレーターixyさんのウェブサイト
1+
[![UnitTest](https://github.com/Ixy194194/ixy194194.github.io/actions/workflows/unittest.yaml/badge.svg?branch=main)](https://github.com/Ixy194194/ixy194194.github.io/actions/workflows/unittest.yaml)
22

3-
このリポジトリはイラストレーターixyさんのウェブサイトのソースコードです。Next.jsを使用して作成されており、GitHub Pagesでホストされています。
3+
# イラストレーター ixy さんのウェブサイト
4+
5+
このリポジトリはイラストレーター ixy さんのウェブサイトのソースコードです。Next.js を使用して作成されており、GitHub Pages でホストされています。
6+
7+
## 使用技術
8+
9+
- [Next.js](https://nextjs.org/) - React ベースのフレームワークで、サーバーサイドレンダリングや静的サイト生成をサポートしています。
10+
- [TypeScript](https://www.typescriptlang.org/) - JavaScript のスーパーセットで、静的型付けを提供しています。
11+
- [Tailwind CSS](https://tailwindcss.com/) - ユーティリティファーストの CSS フレームワークで、迅速なスタイリングを可能にしています。
412

513
## 開発環境のセットアップ
614

7-
1. このリポジトリをクローンします。
8-
```
9-
git clone https://github.com/yourusername/ixy-portfolio.git
10-
```
11-
2. リポジトリのディレクトリに移動し、依存関係をインストールします。
12-
```
15+
```sh
1316
cd ixy-portfolio
1417
npm install
15-
```
16-
3. 開発サーバーを起動します。
17-
```
18+
1819
npm run dev
1920
# or
2021
yarn dev
2122
```
22-
ブラウザで`http://localhost:3000`にアクセスすると、ウェブサイトが表示されます。`pages/index.tsx`を編集すると、ページが自動で更新されます。
23-
24-
## 使用技術
25-
26-
- [Next.js](https://nextjs.org/) - Reactベースのフレームワークで、サーバーサイドレンダリングや静的サイト生成をサポートしています。
27-
- [TypeScript](https://www.typescriptlang.org/) - JavaScriptのスーパーセットで、静的型付けを提供しています。
28-
- [Tailwind CSS](https://tailwindcss.com/) - ユーティリティファーストのCSSフレームワークで、迅速なスタイリングを可能にしています。
2923

3024
## ガイドラインと注意事項
3125

32-
### 技術スタック
33-
- GitHub Pagesを使用すること。
34-
- 外部APIを叩かないこと。
35-
- JSフレームワークを使用する場合は、GatsbyやNext.jsなどの静的サイトジェネレーターを使用すること。
36-
- サイト内にJSが必要な場合は、軽量なライブラリを使用すること。
37-
- サイト内でフォームを使用する場合は、Formspreeなどのフォームハンドリングサービスを使用すること。
26+
- GitHub Pages を使用すること。
27+
- 外部 API を叩かないこと。
28+
- サイト内で利用している画像の著作権は全て Ixy 先生に帰属するものであり、無断でこれを利用することを禁じます。
3829

3930
### レイアウトとデザイン
40-
- サイトの配色やフォントなどのデザインは、ixyさんのイラスト作品と調和するように設計すること。
41-
- サイトのロゴやアイコンは、ixyさんが提供する素材を使用すること。
31+
32+
- サイトの配色やフォントなどのデザインは、ixy さんのイラスト作品と調和するように設計すること。
33+
- サイトのロゴやアイコンは、ixy さんが提供する素材を使用すること。
4234
- サイト内の画像は、必要に応じて適切に最適化すること。
4335

44-
#### SEO
45-
- サイトはSEOに最適化されていること。
46-
- サイト内のすべてのページには、メタタグが適切に設定されていること。
47-
- サイト内のすべての画像には、適切なalt属性が設定されていること。
48-
- サイト内のすべてのページには、XMLサイトマップが設定されていること。
36+
### SEO
37+
38+
- サイトは SEO に最適化されていること。
39+
- サイト内のすべての画像には、適切な alt 属性が設定されていること。
4940

5041
### その他
51-
- サイトのコードは、適切にコメントアウトされていること。
5242

53-
## サポートとフィードバック
43+
- サイトのコードは、適切にコメントが付与されていること。
5444

55-
このプロジェクトに関する質問や提案がある場合は、GitHubのイシュー機能を使用して報告してください。コントリビューションも歓迎します。
45+
## サポートとフィードバック
5646

57-
## ライセンス
47+
このプロジェクトに関する質問や提案がある場合は、GitHub の issue 機能を使用して報告してください。
48+
コントリビューションも歓迎します。
5849

59-
このプロジェクトはMITライセンスの下で公開されています。
50+
**コントリビューションに際しては別途 [CONTRIBUTING.md](./CONTRIBUTING.md) を必ずご一読ください。**

0 commit comments

Comments
 (0)