- On GitHub AE, navigate to the main page of the repository.
- Under your repository name, click Settings.
- In the "Features" section, under "Issues," click Set up templates.
- Use the Add template drop-down menu, and click on the type of template you'd like to create.
- To preview or edit the template before committing it to the repository, click Preview and edit.
- To edit the template, click , and type in the fields to edit their contents.
- To automatically set a default issue title, assign the issue to people with read access to the repository, or apply labels to your issue template, enter these details under "Optional additional information." You can also add these details in the issue template with
assigneesin a YAML frontmatter format.
- When you're finished editing and previewing your template, click Propose changes in the upper right corner of the page.
- Enter a commit message describing your changes.
- Below the commit message fields, decide whether to commit your template directly to the default branch, or to create a new branch and open a pull request. For more information about pull requests, see "About pull requests."
- Click Commit changes. Once these changes are merged into the default branch, the template will be available for contributors to use when they open new issues in the repository.
You can customize the issue template chooser that people see when creating a new issue in your repository by adding a config.yml file to the
You can encourage contributors to use issue templates by setting
false. If you set
true, people will have the option to open a blank issue.
Note: If you used the legacy workflow to manually create an
issue_template.md file and enable blank issues in your config.yml file, the template in
issue_template.md will be used when people chose to open a blank issue. If you disable blank issues, the template will never be used.
If you prefer to receive certain reports outside of GitHub AE, you can direct people to external sites with
Here is an example config.yml file.
blank_issues_enabled: false contact_links: - name: GitHub Community Support url: https://github.community/ about: Please ask and answer questions here. - name: GitHub Security Bug Bounty url: https://bounty.github.com/ about: Please report security vulnerabilities here.
Your configuration file will customize the template chooser when the file is merged into the repository's default branch.
On GitHub AE, navigate to the main page of the repository.
Above the list of files, using the Add file drop-down, click Create new file.
In the file name field, type
In the body of the new file, type the contents of your configuration file.
At the bottom of the page, type a short, meaningful commit message that describes the change you made to the file. You can attribute the commit to more than one author in the commit message. For more information, see "Creating a commit with multiple co-authors."
Below the commit message fields, decide whether to add your commit to the current branch or to a new branch. If your current branch is the default branch, you should choose to create a new branch for your commit and then create a pull request. For more information, see "Creating a new pull request."
Click Propose new file.