Tips:CONTRIBUTINGファイルでプルリクエストの品質を高める

リポジトリの直下か.githubフォルダー以下にCONTRIBUTINGファイルを作成すると、プルリクエストの新規作成画面にCONTRIBUTINGファイルへのリンクが記載されます。このファイルを作成しておくことで、プルリクエストやIssueを送る際のルールの周知を行えます

161222_github_contributing
CONTRIBUTINGファイルへのリンクが表示されている。

161222_contribute

CONTRIBUTINGファイルの例(Atom)。プロジェクトの概要やコントリビュートする際のルールが記載されている。

Tips:PULL_REQUEST_TEMPLATEファイルで
プルリクエストの定型文を決める

リポジトリの直下か.githubフォルダー以下にPULL_REQUEST_TEMPLATEファイルを用意することで、プルリクエストの新規作成時の初期テキストを設定できます。例えば、「プルリクエストを送るに至った経緯」「マージすることで期待できる結果」「このプルリクエストでは行わないこと」「マージ後のリスク」「関連のIssueやURL」等の最低減の必要なプルリクエストのテンプレートを作成しておくことで、レビュワーは一定の情報を持ってプルリクエストを受けることができ、不要な質問のやり取りを減らせます

161222_github_pullrequest_template

Tips:タスクリストを作成する

次のフォーマットでプルリクエストの詳細の入力欄に記入すると、チェックボックスを作成できます。ちょっとしたテスト項目など、作業の管理に使うと便利です。

- [ ] 未完了のタスク
- [x] 完了済みのタスク2

161222_github_tasklist

まとめ

プルリクエストを導入することで、チーム全体のコードやプロジェクトの理解が高まり、コンテンツの品質を上げることができます。まだ、プルリクエストを使ったことがない人も、この機会にぜひ取り入れてみてはいかがでしょうか?