Github Issueを立ててみる

GithubでIssueを立てる方法をおさらいします。

前提

自分で開発しているプライベートリポジトリに立てるIssueで、身内向けのもの。
（OSSというわけでもなく、ある程度気軽に書き込んで構わない。）

GithubのIssueとは

GitHub Issues は、作業を計画、議論、追跡するためにリポジトリで作成できる項目です。
issue は簡単に作成でき、さまざまなシナリオに合わせて柔軟に対応できます。 issue を使用して、作業の追跡、フィードバックの送受信、アイデアやタスクに関する共同作業、他のユーザーとの効率的なコミュニケーションを行うことができます。

わかったような、わからないような……。

Issueとは、英語で

〔議論すべき〕重要な話題［問題］、問題点、論点、争点

といった意味らしいです（参考：英辞郎 on the web）。

具体的には、リポジトリで、「ファイルの読み込みが極めて遅い」みたいな問題提起がされて、誰かがコードを変更してそれを解決したり、「いや、それはまだ対応しないんだ」ということでほっとかれたり、という感じに使われていると思います。

たとえば、misskey（オープンソースの分散型SNS）で立っているIssueがこんな感じです。

バグのほか、「こういう機能を足してほしい」みたいな要望なんかもあげられています。
（覗いてみるのは、ちょっと楽しい。）

自分のリポジトリにIssueを立ててみる

Githubのリポジトリの右上あたり、New issueからIssueを作成します。

タイトルと内容を書きます。

マークダウンが使えます。
ほか、Issueのテンプレートを使用することもできるらしいのですが、今回は身内だしそんなにかっちりしたものでなくてよいので使用しません。

とはいえ、ラベルくらいははっておくことにしましょうか。
とりあえず、機能ではないので、「enhancement」でしょうか。

これでOK。
＃で、通し番号が付与されます。

Open＝未対応のIssueということです。
コードを改造して対応したら、右下のClose IssueでIssueを閉じます。

発展：コミットメッセージによるIssueの自動クローズ

Issueを解決するコードをコミットする際に、コミットメッセージに「fixes #番号」と記述すると、勝手にCloseしてくれます。

例えば、Issue番号が123の場合、コミットメッセージは以下のようになります。

git commit -m "fixes #123 Added caching to improve loading speed"

コミットがマスターブランチやメインブランチにマージされると、コミットメッセージに記述されたIssueが自動的に閉じられます。

• close
• closes
• closed
• fix
• fixes
• fixed
• resolve
• resolves
• resolved

英単語なので、これのために、私は
〇〇に対応しました。 fix #123
みたいなコミットメッセージにしています。

楽なやり方を模索中です。

Issueの削除

Issueは立てるのは簡単ですが削除には権限が必要で、権限がないとたとえ自分の作ったリポジトリのものでも削除できません（組織アカウントのポリシーによる）。
その場合、それとわかるコメントをつけて、Closeしてみなかったことにするしかないようです。