Issue の書き方 - shinkasystems/kintaikanri GitHub Wiki
Issue は論点、問題、関心事という意味です。 バグ、要望、改善案、質問などは Issue として起票してください。
タイトル
Issue の概要を簡潔に表現してください。
本文
バグの場合は、以下の内容をできるだけ詳細に記述してください。
- 問題の事象
- 再現方法
- 修正案
要望や改善案の場合は、 具体的な方策や修正案を記述することが望まれます。
ラベル
Issue の内容に応じて適切なラベルを付与してください。
bug
文字通りバグ(故障)を表します。
duplicate
報告された Issue の内容が過去の Issue と重複していることを表します。 重複していることが起票する前に分かったとしても、報告することが望ましいです。 正しい情報は多いほど良いです。 このラベルは起票者が付与するものではありません。
enhancement
要望や、機能改善を表します。
invalid
報告された Issue そのものが無効であることを表します。 内容に不備があったり、Issue として成り立たない場合付与されます。 このラベルは起票者が付与するものではありません。
question
質問や疑問を表します。
wontfix
対応しないことを表します。 対応することで弊害が発生する場合や、対応することが著しく困難な場合付与されます。 このラベルは起票者が付与するものではありません。