Skip to content

Commit 2524498

Browse files
authored
Merge pull request #19 from first-contributions-ja/docs/#6_create_contributing.md
コントリビューションガイドの作成
2 parents 74a6a84 + 8b8ed4b commit 2524498

File tree

1 file changed

+144
-0
lines changed

1 file changed

+144
-0
lines changed

docs/CONTRIBUTING.md

Lines changed: 144 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,144 @@
1+
# コントリビューションガイド
2+
3+
## GitHub機能の役割
4+
5+
- Discussions: 疑問やアイデアなど、このプロジェクトの開発に関する議論を扱う
6+
- Issues: 機能追加やバグ修正に関する問題を扱う
7+
- Discord(メンバー用): そもそものGithubの使い方・OSSの作法などを中心に、あとで見返さなくてもいいようなカジュアルな内容を扱う
8+
9+
10+
## 基本的な開発方法
11+
12+
1. 作業するIssueに自分をアサインする(「これやります」といった宣言)
13+
1. リポジトリをクローンする
14+
1. 作業用ブランチを作成
15+
1. 変更を加える
16+
1. 変更をコミット
17+
1. 変更をプッシュ
18+
1. mainブランチへのプルリクエスト(PR)を作成
19+
1. レビューとフィードバックに対応
20+
1. mainブランチにマージされる
21+
22+
23+
### 1. 作業するIssueに自分をアサインする
24+
25+
- Issue個別ページ右側にある`Assignees`でアサインする
26+
27+
### 2. リポジトリをクローンする
28+
29+
- [こちら](https://github.com/first-contributions-ja/first-contributions-ja)を開く
30+
- 緑色のCodeボタンをクリックし、GitHub CLIのタブを選択
31+
- ターミナルで実行
32+
33+
### 3. 作業用ブランチを作成
34+
35+
- `git branch docs/#17_test`
36+
- `git branch`でブランチが作成されたか確認する
37+
- `git checkout docs/#17_test`としてbranchに移動
38+
- `git status`でbranchに移動したことを確認
39+
40+
### 4. 変更を加える
41+
42+
必要なファイルに変更を加えます
43+
44+
### 5. 変更をコミット
45+
46+
- `git add .`
47+
- `git commit -m "docs: テストを追加 #17"`
48+
49+
### 6. 変更をプッシュ
50+
51+
- `git push origin <branch名>` もしくは `git push origin head` でプッシュ
52+
53+
### 7. mainブランチへのプルリクエスト(PR)を作成
54+
- プルリクエストの作成
55+
- リポジトリのCodeページ上部の黄色く表示された部分から
56+
- リポジトリのCodeページ > ブランチ > 該当ブランチ > Contribute > Open pull requestから
57+
- テンプレートに沿ってtitle、descriptionをうめる
58+
- Create pull requestボタンでプルリクを作成する
59+
60+
### 8. レビューとフィードバックに対応
61+
62+
- 誰かをレビュワーにアサインする
63+
- 誰かがレビューをする
64+
- 修正があれば対応する
65+
66+
### 9. mainブランチにマージされる
67+
68+
- レビューした人が Marge pull requestをして、mainブランチにマージされる
69+
70+
### 10. 最新のmainブランチを取得、反映
71+
72+
- `git checkout main` でmainブランチに移動
73+
- `git status`で状況を把握
74+
- `git pull origin main`
75+
- ref: [リモートリポジトリから変更を取得する - GitHub Docs](https://docs.github.com/ja/get-started/using-git/getting-changes-from-a-remote-repository)
76+
77+
## Discussions
78+
79+
- **作成ルール**
80+
- 同様の議論がないか確認
81+
- なければ新しくDiscussionを作成
82+
- **カテゴリー**
83+
- `General`: カテゴリー不明、未分類の内容
84+
- `Ideas`: 新機能を提案する
85+
- `Polls`: 多数決や投票をする
86+
- `Q&A`: 技術面について不明なことを相談する
87+
- **テンプレート**
88+
- 基本的になし
89+
- `Q&A` はなるべく具体的に困っている内容、試したこと、どうなって欲しいのかを記述する(できればで可)
90+
- **DiscussionsのIssue化**
91+
- 新機能追加が確定したり、バグについての話題が上がった場合は、Discussionsの内容をもとにIssueを立て、タスク化する
92+
- issue化したらcloseする
93+
94+
95+
## Issues
96+
97+
- **作成ルール**
98+
- 基本的にDiscussionやDiscordで決まった新機能や、バグについてのみIssueを立てる
99+
- **作成手順**
100+
- 各テンプレートに沿って内容を作成
101+
- 未設定(後日追加予定)
102+
- [新機能追加のテンプレート]()
103+
- [バグ修正のテンプレート]()
104+
- **Closeについて**
105+
- Issueに伴うブランチがマージされたらcloseすること(Pull Requestのコメントでcloseする)
106+
107+
108+
## Pull Request
109+
110+
- 未設定(後日追加予定)
111+
- [テンプレート]()
112+
113+
**現状フォーマット**
114+
115+
```markdown
116+
## 概要
117+
118+
## 関連するIssue
119+
closed #issue番号
120+
```
121+
ref: [行動規範の作成 by kazzyfrog · Pull Request #14 · first-contributions-ja/first-contributions-ja](https://github.com/first-contributions-ja/first-contributions-ja/pull/14)
122+
123+
## Branch
124+
125+
- 命名規則
126+
- 基本: `prefix/#issue番号_タイトル`
127+
- 例: `docs/#01_create_documents`
128+
- prefix
129+
- `feat`: 新機能追加関連
130+
- `docs`: ドキュメント関連
131+
- `fix`: バグ修正関連
132+
- その他は適宜追加
133+
134+
135+
## コミットメッセージ
136+
137+
- 命名規則
138+
- 基本: `prefix: 内容 #issue番号`
139+
- 例: `docs: README.md 日本語訳追加 #12`
140+
- prefix
141+
- `feat`: 新機能追加関連
142+
- `docs`: ドキュメント関連
143+
- `fix`: バグ修正関連
144+
- その他は適宜追加

0 commit comments

Comments
 (0)