Issue の書き方って、個人差出るんすよね
バグ報告の Issue を眺めていると、大抵、この辺のことが気になり始めるんですよ。
- iOS / Android どっちで発生したんだろう？ 🤔
- 端末の OS バージョンはいくつだろう？ 🤔
- DeployGate のバージョンはいくつだろう？ 🤔
- どの画面で、どんなタイミングで落ちたんだろう？ 🤔
- 再現手順はあるのかな？ 🤔
- たまにしか起きないやつなのかな？ 🤔
- 表示がおかしいみたいだけど、どうおかしいんだろう？ 🤔
- 画面がチラつくらしいけど、どうチラつくんだろう？ 🤔
- 現行バージョンでも発生するのかな？ 🤔
悩みは尽きませんよね・・・。
こういった一次情報を書いて残してくれているひともいれば、書いていないひともいます。また、書いているときもあれば、書いていないときもあったりします。
バグの原因を調査するとき、これらの一次情報があるかないかで、バグの原因を突き止めるまでの時間に大きな差が生まれます。一次情報が少なければ、なんかこの辺でなんか起きるらしいぞ？という漠然とした推測のもとに調べていかないといけません。
だからこそ、出来るだけ Issue に個人差を持ち込まずに、Issue の書き方の足並みを揃えたいんですよ。
よーし！Issue Template を導入だっ！
Issue にはさ、こういうことを書いて欲しいんすよ〜！って伝えたとしても、Issue を書くのは人間なので、うっかり、忘れちゃったりするんですよね。でも、まぁ、仕方ないよね〜！っていうことで済ませるわけにもいかないので、どうしたらいいかを考えてみました。
恐らく、みんな、エンジニアが調査をするときにどういう情報が書いてあると嬉しいのか、といった部分が共有されていないことが問題なのかもしれないなぁと考え、こういう情報が書いてあると嬉しいんすよ〜！っていう項目をまとめた Issue Template を作ってみました。
esa に記事を書いて例文を載せたりもして、定例のときに、今度からこの Issue Template を活用して行きましょう！と周知したつもりではあったんだけど、それでも、まだ、個人差が出ていました。
なんでだろう？とその理由を考えてみると、waffle.io で Issue を作成するとき、毎回、入力フォームに Issue Template をコピペするの、つらみがあるんですよね・・・そりゃ、そうだよね！無理を言って申し訳ないっ！
ということで、GitHub の Issue Template を使って、自動的に差し込んじゃおうとも考えたんですが、弊社は、Issue を waffle.io で管理していて、この機能が使えなかったんですよね。waffle.io に、要望はたくさん上がってるっぽいんですけど、まだ、対応はされてないようです。
もう待てんっ！ということで、勝手に waffle.io に Issue Template を差し込む Chrome 拡張を作ってみました。
スッと入る Issue Template で統一感を！
初めて Chrome 拡張に手を出したので、理解も浅いんですけど、一応、それっぽいやつは出来ました。こんな感じになります。
スッと感ある。
まだ、実戦投入してなくて、これから、社員のみんなにインストールしてもらって運用して行く感じです。本当は、Issue Template 部分は、自由に書き換えられたり、GitHub に置いた Issue Template を読み込めるとオシャレなんですけど、早く運用したさのあまり、コードにベタ書きしてしまいましたが、後悔はしていません。
足並みをそろえる第一歩になればいいなぁ。
