リポジトリ用の単一 Issue テンプレートを手動で作成する
手動で作成した Issue テンプレートをリポジトリに追加すると、プロジェクトのコントリビューターは自動的に Issue の本体でテンプレートの内容が見えるようになります。
これはIssueのテンプレートを作成するための古いワークフローです。アップグレードされた複数のIssueテンプレートビルダーを使って複数のIssueテンプレートを作成することをおすすめします。詳しい情報についてはIssue及びプルリクエストテンプレートを参照してください。
サポートしているどのフォルダーにでも ISSUE_TEMPLATE/ サブディレクトリを作成し、Issue テンプレートを複数含めることができます。また、template
クエリパラメータで Issue の本文に使用するテンプレートを指定できます。 詳細は「クエリパラメータによる Issue およびプルリクエストの自動化について」を参照してください。
Issue テンプレートを追加する
-
GitHub Enterprise で、リポジトリのメインページへ移動します。
-
ファイルリストの上にある [Create new file(新しいファイルを作成)] をクリックします。
-
ファイル名フィールドで:
- Issue テンプレートをリポジトリのルートディレクトリで表示するには、issue_template の名前を入力します。 たとえば、
issue_template.md
です。 - Issue テンプレートをリポジトリの
docs
ディレクトリで表示するには、docs/ と入力し、続いて issue_template という名前を入力します。 たとえば、docs/issue_template.md
です。 - ファイルを隠しディレクトリに格納するには、.github/ と入力し、続いて issue_template という名前を入力します。 たとえば、
.github/issue_template.md
です。 - 複数 Issue テンプレートを作成し、
template
クエリパラメータを使用して Issue の本文に使用するテンプレートを指定するには、.github/ISSUE_TEMPLATE/ と入力し、続けて Issue テンプレートの名前を入力します。 たとえば、.github/ISSUE_TEMPLATE/issue_template.md
です。 複数 Issue テンプレートをルートディレクトリやdocs/
ディレクトリにあるISSUE_TEMPLATE
サブディレクトリに格納することもできます。 詳細は「クエリパラメータによる Issue およびプルリクエストの自動化について」を参照してください。
- Issue テンプレートをリポジトリのルートディレクトリで表示するには、issue_template の名前を入力します。 たとえば、
-
新しいファイルの本文に Issue テンプレートを追加します。 そこに盛り込むべき項目として、以下のようなものがあります:
- 予測される動作と実際の動作
- 問題の再現手順
- プロジェクトのベンダー、オペレーティング システム、ハードウェアなどの仕様。
-
ページの下部で、ファイルに行った変更について述べた短く意味のあるコミットメッセージを入力してください。コミットメッセージ内でコミットを複数の作者に関連付けることができます。詳細は「複数の共同作者を持つコミットを作成する」を参照してください。
-
コミットメッセージフィールドの下で、コミットを現在のブランチに追加するか、新しいブランチを作成するかを判断してください。現在のブランチが
master
なら、コミットに新しいブランチを作成することにして、プルリクエストを作成してください。テンプレートがリポジトリのデフォルトブランチにマージされると、コラボレーターがテンプレートを使用できるようになります。 -
[Propose new file(新しいファイルを提案)] をクリックしてください。