GitHub Scripting

Github: About issue and pull request templates

With issue and pull request templates, you can customize and standardize the information you’d like contributors to include when they open issues and pull requests in your repository.

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.”

Issue templates

When you create issue templates for your repository using the issue template builder, they’ll be available for contributors to use when they open new issues in the repository.

New issue page showing issue template choices

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 “Creating issue templates for your repository.”

Issue templates are stored on the repository’s default branch, in a hidden .github/ISSUE_TEMPLATEdirectory. If you create templates on other branches, they will not be available for collaborators to use. Issue template filenames are not case sensitive, and can have an extension such as .md or .txt.

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 to create issue templates. For more information about the legacy workflow, see “Manually creating a single issue template for your repository.”

Pull request templates

When you add a pull request template to your repository, project contributors will automatically see the template’s contents in the pull request body.

Sample pull request template

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.”

Learn more