yousan/.github

GitHub Template

GitHubテンプレート用のリポジトリです。

確認はこちらから

内容

二種類のIssueテンプレートが入っています。

簡易版は普段書くためのテンプレートです。 テンプレートのサンプル

詳細版はIssueを書くことに慣れていない人向けのテンプレートです。

詳細版のサンプル1

詳細版のサンプル2

テンプレート無しでも書くことができます

デフォルトのラベルを付けることができます

ちなみに仕様かバグかの境界線上の場合、bugのラベルよりenhancementのラベルの方がよいかもしれません 👼

インストール方法

リポジトリ直下から.github/ISSUE_TEMPLATEディレクトリにテンプレートファイルをダウンロードします。

下記のようにするとディレクトリを作成してファイルをダウンロード、保存します。

$ curl https://raw.githubusercontent.com/yousan/github_template/master/install.sh | sh - 

下記のコマンドでダウンロードできます。

$ mkdir -p .github/ISSUE_TEMPLATE

$ curl -o .github/ISSUE_TEMPLATE/default.md https://raw.githubusercontent.com/yousan/github_template/master/.github/ISSUE_TEMPLATE/default.md
$ curl -o .github/ISSUE_TEMPLATE/detailed.md https://raw.githubusercontent.com/yousan/github_template/master/.github/ISSUE_TEMPLATE/detailed.md

テンプレート自体について

テンプレートの内容は自分が書いたほうが良いことを記述しています。 閉じられなくなってしまったタスクや、どうしたら良いのか迷わないように項目を立てています。

参考

https://tech.gamewith.co.jp/entry/2018/05/22/154951

https://engineering.crocos.jp/post/98455177675/pull-request-%E3%81%AE%E3%83%95%E3%82%A9%E3%83%BC%E3%83%9E%E3%83%83%E3%83%88%E3%82%92%E6%B1%BA%E3%82%81%E3%82%8B%E3%81%A8%E3%83%AC%E3%83%93%E3%83%A5%E3%83%BC%E3%81%AE%E5%8A%B9%E7%8E%87%E3%81%8C3%E5%80%8D%E3%82%88%E3%81%8F%E3%81%AA%E3%82%8B

動かない場合

動かない場合にはご連絡ください。