Yak shaving logs


My life is just yak shaving.

[GitHub] IssueとPull Requestのテンプレート機能を利用してフォーマットを統一する

2017/08/04 #github #tips

By Yusuke Takita


こんにちは。Takitaです。

IssueとPull Requestのテンプレートを作成しておけば、Issue・Pull Requestを作成するタミングでテンプレートの内容をデフォルトで表示してくれる機能があります。Issue・Pull Requestを作成する人が複数人いる場合は、フォーマットが人に依存したり、フォーマットの指定があっても守ってくれない人がいるケースもあると思いますが、GitHubのテンプレ機能を利用することで、作業者が複数人でも統一したフォーマットをあらかじめ用意しておくことができます。

RailsのリポジトリでもGitHubのテンプレート機能は使われています。

テンプレートの配置場所

以下のどちらかにテンプレートファイルを配置してください。

  • リポジトリのルートディレクトリ
  • .github/ ディレクトリ直下

Railsは .github/ 以下にファイルを置いているのでぼくもそれにあわせてみました。

テンプレートファイル

マークダウンに対応しているので以下の名前で *.md ファイルを作成します。

  • PULLREQUESTTEMPLATE.md
  • ISSUE_TEMPLATE.md

以下のような感じでファイルを置いてください。
GitHubの説明上はファイル名は大文字なのですが、小文字にしても問題ありません。

https://github.com/tackeyy/blog/pull/20/files

.github/issue_template.md

+### Summary
+
+### TODO
.github/pull_request_template.md

+fixes #
+
+### Summary
+
+### Other Information

どんな感じになるか?

https://gyazo.com/0e5c8987493093e890c54ef5c65cf3d9

https://gyazo.com/8c9856aea4582a9ca187f88b610538a2

(昔のbranchからmasterに向けたPull Requestなのでコンフリクトしてます)

参考

https://github.com/blog/2111-issue-and-pull-request-templates

このエントリーをはてなブックマークに追加

categories


最新記事


tags