リポジトリ用の単一 Issue テンプレートを手動で作成する
手動で作成した Issue テンプレートをリポジトリに追加すると、プロジェクトのコントリビューターは自動的に Issue の本体でテンプレートの内容が見えるようになります。
ここには以下の内容があります:
これはIssueテンプレートを作成するためのレガシーのワークフローです。 複数のIssue テンプレートの作成にはアップグレードされた複数 Issue テンプレートビルダーを使うことをおすすめします。 詳しい情報についてはIssue およびプルリクエストのテンプレートについてを参照してください。
サポートしているどのフォルダーにでも ISSUE_TEMPLATE/ サブディレクトリを作成し、Issue テンプレートを複数含めることができます。また、template
クエリパラメータで Issue の本文に使用するテンプレートを指定できます。 詳細は「クエリパラメータによる Issue およびプルリクエストの自動化について」を参照してください。
You can add YAML frontmatter to each issue template to pre-fill the issue title, automatically add labels and assignees, and give the template a name and description that will be shown in the template chooser that people see when creating a new issue in your repository.
Here is example YAML front matter.
---
name: Tracking issue
about: Use this template for tracking new features.
title: "[DATE]: [FEATURE NAME]"
labels: tracking issue, needs triage
assignees: octocat, octo-org/octo-team
---
Note: You must put YAML-reserved characters such as :
in quotes. For example, ":bug: Bug"
.
Issue テンプレートを追加する
-
GitHub Enterpriseで、リポジトリのメインページにアクセスしてください。
-
ファイルの一覧の上にある Create new file(新規ファイルの作成)をクリックしてください。
-
ファイル名フィールドで:
- Issue テンプレートをリポジトリのルートディレクトリで表示するには、issue_template の名前を入力します。 たとえば、
issue_template.md
です。 - To make your issue template visible in the repository's
docs
directory, type docs/ followed by the name of your 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 テンプレートを追加します。 そこに盛り込むべき項目として、以下のようなものがあります:
- YAML frontmatter
- Expected behavior and actual behavior
- Steps to reproduce the problem
- Specifications like the version of the project, operating system, or hardware
-
ページの下部で、ファイルに対して行った変更を説明する短く分かりやすいコミットメッセージを入力してください。 コミットメッセージでは、複数の作者にコミットを関連づけることができます。 詳しい情報については「複数の共作者を持つコミットの作成」を参照してください。
-
コミットメッセージフィールドの下で、コミットの追加先を現在のブランチか新しいブランチから選択してください。 現在のブランチが
master
であれば、コミット先として新しいブランチを作成することを選択し、続いてプルリクエストを作成しなければなりません。 詳しい情報については「新しいプルリクエストの作成」を参照してください。Templates are available to collaborators when they are merged into the repository's default branch. -
Propose new file(新規ファイルの提案)をクリックしてください。