【Githubの勉強】

GitHubでIssueを書くときに気をつけることとかいろいろ

GitHub：ドキュメント

参考：Issuesの理解

Issueの書き方.md

Issues
課題管理機能Issues（イシュー）とは
「Issue」は、「問題」や「課題」といった意味
GitHubのIssues機能もその名の通り、プロジェクトやソースコードの課題を管理するための機能です。
・Issuesを使ってみる 担当者を明確にするAssignee（アサイニー）機能
・Projectを指定するProjects（プロジェクト）機能
・スケジュールを管理するMilestone（マイルストン）機能
・増えたIssueを整理するLabel（ラベル）機能

Title

タイトルだけでIssueの内容が把握できるようにする。

Issueがバグの場合は、設計要素の名称を書く。

【xx画面】xxボタン押下時にエラー など...

Comment

Issueがバグの場合、以下の内容を簡潔に書く。
Issueがバグの場合、以下の内容を簡潔に書く。

問題の内容
複数の問題をひとつのIssueに含めない。面倒だけど問題の数だけIssueを発行する。

実行環境

OSやブラウザのバージョンなど

Windows 7 、Chrome 44、Mac

再現手順
できる限り詳しく再現の手順を書く。

xx画面を表示する
xx項目にユーザ名を入力する
xxボタンを押下すると「～～～」というエラーが表示される
修正すべき内容
どうなるのが正しい動作を書く。
わかれば修正の仕方も書く。

Labels

good first issue
→ Good for newcomers

bug
バグ対応：バグ報告をするときに使う。
→ 修正したらクローズする

duplicate
重複：過去に報告されているIssueと重複しているときに使う。
※ 報告者は使わない
→ 重複先のIssueにリンクしてクローズする

enhancement
要望・改善：機能追加の要望や改善してほしいときに使う。
→ 実装したらクローズする

invalid
仕様通り：Issueの内容が間違いであるときに使う。仕様通り。 ※ 報告者は使わない
→ 対処しない理由を書いてクローズする

question
質問：質問したいときに使う。
→ 質問・議論の答えがでたらクローズする

wontfix
対処しないバグ：認知しているけど対処しないバグのときに使う。
※ 報告者は使わない
→ 対処しない理由を書いてクローズする

help wanted
求人募集
Issue の助けを求めるときに使う。→ 対応した場合、理由を書いてクローズする。

README.md
必読
先に読んでほしいもの や 特に一読してほしいものに関してはこちらをご利用ください。

documentation
ドキュメント改善・追加
ドキュメントの改善または追加

イラストファイル
イラストファイル資料があります。

ドキュメントファイル
ドキュメントファイル資料があります。

Milestone

マイルストーンを指定することで、「いつまでに何をやらなければならないのか」が集計される。

タスク管理や進捗管理として使われる。

Assignee

Issueを誰に割り当てるかを指定する。

Issueをクローズするコミットメッセージ
コミットメッセージに以下のフォーマットで記述すれば、自動的に該当Issue（#12）がCloseされる。

fix #12
fixes #12
fixed #12
close #12
closes #12
closed #12
resolve #12
resolves #12
resolved #12