GitHub Template

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

GitHubではリポジトリの .github/ ディレクトリに特定のファイルを置くことで、IssueやPullRequestにテンプレートを適応できるようになります。

チームでリポジトリを使う場合のガイドラインとしてテンプレートをご利用ください。

確認はこちらから

内容

二種類の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

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

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

参考

• GitHub Issue Template が公式で複数対応したので、早速利用してみた
• チームタスクを3倍スムーズに進めるGit/Githubのコメントフォーマット

動かない場合

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