You can create default issue templates and a default configuration file for issue templates for your organization or user account. For more information, see "Creating a default community health file."
- On GitHub, 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.
Note: Issue forms are currently in beta and subject to change.
With issue forms, you can create issue templates that have customizable web form fields. You can encourage contributors to include specific, structured information by using issue forms in your repository. Issue forms are written in YAML using the GitHub form schema. For more information, see "Syntax for GitHub's form schema." If you're new to YAML and want to learn more, see "Learn YAML in Y minutes."
To use an issue form in your repository, you must create a new file and add it to the
.github/ISSUE_TEMPLATE folder in your repository.
Here is an example of an issue form configuration file.
name: Bug Report description: File a bug report title: "[Bug]: " labels: ["bug", "triage"] assignees: - octocat body: - type: markdown attributes: value: | Thanks for taking the time to fill out this bug report! - type: input id: contact attributes: label: Contact Details description: How can we get in touch with you if we need more info? placeholder: ex. firstname.lastname@example.org validations: required: false - type: textarea id: what-happened attributes: label: What happened? description: Also tell us, what did you expect to happen? placeholder: Tell us what you see! value: "A bug happened!" validations: required: true - type: dropdown id: version attributes: label: Version description: What version of our software are you running? options: - 1.0.2 (Default) - 1.0.3 (Edge) validations: required: true - type: dropdown id: browsers attributes: label: What browsers are you seeing the problem on? multiple: true options: - Firefox - Chrome - Safari - Microsoft Edge - type: textarea id: logs attributes: label: Relevant log output description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks. render: shell - type: checkboxes id: terms attributes: label: Code of Conduct description: By submitting this issue, you agree to follow our [Code of Conduct](https://example.com) options: - label: I agree to follow this project's Code of Conduct required: true
Here is the rendered version of the issue form.
- Choose a repository where you want to create an issue form. You can use an existing repository that you have write access to, or you can create a new repository. For more information about creating a repository, see "Creating a new repository."
- In your repository, create a file called
FORM-NAMEwith the name for your issue form. For more information about creating new files on GitHub, see "Creating new files."
- In the body of the new file, type the contents of your issue form. For more information, see "Syntax for issue forms."
- Commit your file to the default branch of your repository. For more information, see "Creating new files."
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 in the
.github folder 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, 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, 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.