みなさまこんにちは
chromeのextensionを作ったので紹介します。
issueのテンプレートはすごくいいと思います。
でもそこへのサポートが薄いので、テンプレート運用する時にいい感じにするchrome extensionを作りました。
あともう1つの理由は、chrome extensionを作ってみたかったから
作ったもの
Githubでissueの雛形を保存しておける拡張機能です。
この一瞬で気になっちゃった方はこちらから
useful issues
issueにテンプレートを使う
僕が携わっているプロジェクトではissueを書くときにテンプレートを使っています。
テンプレートに沿ってissueを立てることで誰が書いても最低限の情報が記載され、
「ん?こいつはなにが言いたいんだ」ということが少なくなります。
質のばらつきや情報のヌケモレがなくなり、足りない情報だけを求めればいいですね
書いてあることを直接本人に尋ねるなんて二度手間なことを避けられますね
issueを立てるのにwikiにいく
GitHubではissueのテンプレートを作成できる仕組みが備わっています。
GitHub Issueはテンプレート化で、綺麗に書かせる!
こちらの記事で紹介されているように、issueの新規作成ページにgetパラメータを渡すことで、テンプレート(各項目のデフォルト値)を指定できます。
僕らはこれを利用させていただき、目的別に4つのテンプレートを作って、wikiにリンクを張っています。
こんな感じで
だから、「issueを作るためにはwikiを開きます」
頭の中は「issue立てよー」となっているのに「issueのページじゃなくwikiに」行かないといけないんですね。
このせいでちょっとさみしい気持ちになった回数は数えきれません
ISSUE_TEMPLATE.mdファイルを用意することでもテンプレートを用意できるそうですが、1種類だけ?しか用意できない?っぽい?のでスルーです
Issue and Pull Request templates
issueのテンプレートを再利用するchrome extensionを作った
このような背景でissueのテンプレートを再利用するchrome extensionを作りました。
こちらからDLできます
useful issues
useful issuesでできること
いろいろとアイデアは出てきますが今できるのはこの3つ
- issueテンプレートの保存
- issueテンプレートの適用
- issueテンプレートの削除
issueテンプレートの保存
1. issueの作成ページを開く
2. useful issuesのsaveボタンを押下
issueテンプレートの適用
1. issueページでテンプレートを書く
2. useful issuesのapplyボタンを押下
issueテンプレートの削除
popupのconfigボタンからひらけます。
保存しているテンプレートのプレビューと、削除ができます。
インストール
こちらから
useful issues
chrome extensionの作り方
HTML・CSS・Javascriptで作ります。
初めてだったのでいろいろ参考にさせていただきました。
- extensionを作るときの雛形や開発ツールを一通り用意してくださっています。gulp・babel・SCSSに知見のある方向けです。
2016年度版 僕が考えたChrome拡張機能を作るときのデザインパターン - chrome extensionの構成を簡潔に解説してくださってます。あの拡張はこの機能で作られてるのね〜ってなります
Chrome拡張 | アーキテクチャ - 本家ドキュメントで、APIの具体例も載ってます
What are extensions? - Google Chrome
まとめ
chrome環境でしか動かないので、ブラウザ環境を気にする必要がなくてよかったです
あとここからインストールできます
useful issues