Githubでプルリクエストをするときにテンプレートを読み込むように設定しておくことが可能であることがわかりましたので、以下に纏めておきます!
複数人でのチーム開発を行う際に、共通するテンプレートを作成しておくことで、抜け漏れ防止・効率的なプルリクエストのレビューをすることが可能になると思います!
この機能を活用して、効率的に作業をしていきましょう!
#ポイント
今回の実装に関するポイントを纏めます。
- ".github"フォルダにファイルを作成
- ファイル名は"PULL_REQUEST_TEMPLATE.md"
以上です。簡単に実装できます。
#作業手順
それでは、作業手順を纏めていきます。
- Githubの該当リポジトリ上、"create new file"を押す。
- ファイル名に".github/"と入力
- さらに"PULL_REQUEST_TEMPLATE.md"と入力
- テンプレートを空白のテキストエリアに入力
- タイトルを入力したら、"commit new file"を押す
今回、プルリクエストのテンプレートは以下のようにしました。
======================================
What
- Gem変更:
- DB変更:
- 機能変更:
- スクショ:
- その他:
Why
- 問題:
- 原因:
- 解決方法:
*問題なく、単純に機能追加などの場合は追加した理由を記載
======================================
以上でファイルが作成完了しております。
#実際にプルリクエストをしてみる。
上記にてプルリクエストのテンプレートが準備できましたので、実際にプルリクエストしてみましょう。
しっかりとテンプレートが挿入されてますね。
これで、複数人で一つのアプリを作成するときに、抜け漏れなくプルリクエストができるようになります。
#ちなみに
今回のテンプレートは、contributingとissueにも対応しております。
その場合は".github"直下に以下のファイル名で作成しましょう。
contributing: CONTRIBUTING.md
issue : ISSUE_TEMPLATE.md
#参照
Issue and Pull Request templates
https://github.blog/2016-02-17-issue-and-pull-request-templates/
GitHubのIssue・Pull Requestのテンプレート機能を使おう
https://qiita.com/nyamogera/items/3fe6985b45fbd5377184
GitHubでディレクトリ作成
http://maeokaka.hatenablog.jp/entry/2016/07/07/001441
以上となります。最後までご覧いただき、ありがとうございました!
今後も学習した事項に関してQiitaに投稿していきますので、よろしくお願いします!
記述に何か誤りなどございましたら、お手数ですが、ご連絡いただけますと幸いです。