GitHub Issueはテンプレート化で、綺麗に書かせる!

  • 495
    Like
  • 1
    Comment
More than 1 year has passed since last update.

まず、クリックしてみてください

Issue作成はこちら

スクリーンショット 2015-01-27 16.22.05.png


GitHubのIssueは、URLにparamsを渡すことで、デフォルトのvalueが入れられます。
※paramsの渡し方は、/issues/new?title=test&body=contentのようにします。

バグ報告はこちらとかアイディア投稿などのリンクをREADMEなどに置き、みんなそれに従ってIssueを作成してもらいましょう。

指定できるparams

指定できるパラメーターは以下です。

params一覧

  • title
  • body
  • assignee
  • labels
  • milestone

※ラベル、マイルストーンはcontributorsのみ使用可能

文字列のエスケープ

URLに入力するので、改行コードなどをエスケープする必要があります。

文字 エスケープ後
空白 %20
改行 %0A
# %23
* %2a
- %2d
[ %5B
] %5D

詳しくは、URLの文字列エスケープを調べてみてください。

コマンドラインから、フォーマットを使用したPull Requestを作成する

hubコマンドを使用すれば、コマンドラインから一発でフォーマットに沿ったPRを作成できます。

これは、現在のブランチからフォーマットに沿ったPRを作成するためのエイリアスです。

.gitconfig
[alias]
  pr = !hub browse -- compare/$(git symbolic-ref --short HEAD)'?'expand=1'&'body=%23%23%20%E7%9B%AE%E7%9A%84%0A%0A%23%23%20%E5%A4%89%E6%9B%B4%E5%86%85%E5%AE%B9

※パラメーターを複数渡す場合は&をクオーテーションで囲まないと別で走ってしまいます

参考にしたい、美しいIssueとPull Requestの作り方

Github「完璧なプルリクの書き方を教えるぜ」
http://qiita.com/umanoda/items/93aec41213f8e3ce14c8

How We Write Github Issues
http://wiredcraft.com/posts/2014/01/08/how-we-write-our-github-issues.html

見通しの悪いIssueやPull Requestを増やす前に、テンプレート使用して一気に見やすくしましょう!