After you create issue and pull request templates in your repository, contributors can use the templates to open issues or describe the proposed changes in their pull requests according to the repository's contributing guidelines. For more information about adding contributing guidelines to a repository, see "Setting guidelines for repository contributors."
You can create default issue and pull request templates for your organization or personal account. For more information, see "Creating a default community health file."
When you create issue templates for your repository using the issue template builder or with issue forms, contributors can select the appropriate template when they open new issues in the repository.
Issue templates are helpful when you want to provide guidance for opening issues while allowing contributors to specify the content of their issues. If you want contributors to provide specific, structured information when they open issues, issue forms help ensure that you receive your desired information.
Using the template builder, you can specify a title and description for each template, add the template content, and either commit the template to the default branch or open a pull request in the repository. The template builder automatically adds the YAML front matter markup that is required for the template to show on the new issue page. For more information, see "Configuring issue templates for your repository."
With issue forms, you can create templates that have web form fields using the GitHub form schema. When a contributor opens an issue using an issue form, the form inputs are converted to a standard markdown issue comment. You can specify different input types and set inputs as required to help contributors open actionable issues in your repository. For more information, see "Configuring issue templates for your repository" and "Syntax for issue forms."
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
.github/ISSUE_TEMPLATE folder. For more information, see "Configuring issue templates for your repository."
Issue templates are stored on the repository's default branch, in a hidden
.github/ISSUE_TEMPLATE directory. If you create a template in another branch, it will not be available for collaborators to use. Issue template filenames are not case sensitive, and need a .md extension. Issue templates created with issue forms need a .yml extension. To be displayed with a checkmark in the community profile checklist, issue templates must be located in the
.github/ISSUE_TEMPLATE folder and contain valid
about: keys in the YAML frontmatter (for issue templates defined in
.md files) or valid
description: keys (for issue forms defined in
It is possible to manually create a single issue template in Markdown using the legacy issue template workflow, and project contributors will automatically see the template's contents in the issue body. However, we recommend using the upgraded multiple issue template builder or issue forms to create issue templates. For more information about the legacy workflow, see "Manually creating a single issue template for your repository."
You can create a security policy to give people instructions for reporting security vulnerabilities in your project. For more information, see "Adding a security policy to your repository."
When you add a pull request template to your repository, project contributors will automatically see the template's contents in the pull request body.
You must create templates on the repository's default branch. Templates created in other branches are not available for collaborators to use. You can store your pull request template in the repository's visible root directory, the
docs folder, or the hidden
.github directory. Pull request template filenames are not case sensitive, and can have an extension such as .md or .txt.
For more information, see "Creating a pull request template for your repository."