CONTRIBUTING.mdの作成（コントリビューションをどのようにしていくかのルール作成）

[pss-aileen]

タスク

- [ ] 開発方法を画像含めてまとめる
- [ ] まとめたらコミット、プルリクを一旦出す

---

参考

• ★ チーム内でなんとなくやっていたIssueやPR作成についてガイドライン化してCONTRIBUTING.mdに書き起こしてみた | DevelopersIO
• ★ オープンソースプロジェクトを始めよう | Open Source Guides
  • 行動規範にも関係する内容。

内容の例

• opengovernment/CONTRIBUTING.md at master · opengovernment/opengovernment
• rails/CONTRIBUTING.md at main · rails/rails
• js-primer/CONTRIBUTING.md at master · asciidwango/js-primer
• jp.vuejs.org/CONTRIBUTING.md at lang-ja · vuejs/jp.vuejs.org
• これがわかりやすい how-to-contribute-to-open-source/CONTRIBUTING.md at main · freeCodeCamp/how-to-contribute-to-open-source

[pss-aileen]

• discussions：疑問やアイデアなど、このプロジェクトの開発に関する議論を扱う
• issue：機能追加やバグ修正に関する問題を扱う
• Discordのこのチャンネル：そもそものGithubの使い方・OSSの作法などを中心に、あとで見返さなくてもいいようなカジュアルな内容を扱う

Discordより

[pss-aileen]

コミットは、そこまで厳格じゃなくていいと思いますが、１issues、１コミットを基本にすると良さそうです！

[pss-aileen]

• ブランチの名前の決め方とかも必要？
  • dev_#6 といったissue番号に基づくものか
  • feat_#6 的なものか...
  • ドキュメントの追加は docs_#6 とか....？

[pss-aileen]

ローカルにクローンして、
issueの内容ごとにブランチを切って、
色々修正、追加が終わったらmainにプルリクエストを出す

[pss-aileen]

【メモ】Issueドリブン開発とブランチ命名規則ついて【Git】 #GitHub - Qiita

[pss-aileen]

すごく雑ですが、5割?ぐらい作ってみました。

first-contributions-ja/docs/CONTRIBUTING.md at docs/#6_create_contributing.md · first-contributions-ja/first-contributions-ja

気になる点、疑問点

@kazzyfrog @kagomen kanaさん

• 一人で適当にプルリクはできますが、チームでのきちんとしたやり方がわかりません
• ブランチの命名規則に迷っています
  • 【メモ】Issueドリブン開発とブランチ命名規則ついて【Git】 #GitHub - Qiita
  • ↑を参考にしたが、このような命名方法でよいかわからない
  • issue-#4 的にもっと簡単にした方が良いのか？
• 他追加した方が良いものはありますか？

[pss-aileen]

• レビューのルール
• プルリクの概要の書き方（テンプレ）

[pss-aileen]

画像大変なので、一旦文字だけで。