Skip to main content

Using templates to encourage useful issues and pull requests

Repository maintainers can add templates in a repository to help contributors create high-quality issues and pull requests.

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.

Configuring issue templates for your repository

You can customize the templates that are available for contributors to use when they open new issues in your repository.

Syntax for issue forms

You can define different input types, validations, default assignees, and default labels for your issue forms.

Syntax for GitHub's form schema

You can use GitHub's form schema to configure forms for supported features.

Creating a pull request template for 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.

Manually creating a single issue template for your repository

When you add a manually-created issue template to your repository, project contributors will automatically see the template's contents in the issue body.

Common validation errors when creating issue forms

You may see some of these common validation errors when creating, saving, or viewing issue forms.