A pull request template is a predefined Markdown form that standardizes the context contributors provide when proposing a code change. It prompts for the change’s reason, scope, and review information so reviewers are not left searching for background or guessing at intent. section 8.8
Configure a template by:
- Creating .github/pull_request_template.md in the repository. section 8.5.2
- Adding a short set of prompts, such as why the change is needed, its scope, and whether local tests have run. section 8.5.2
- Committing the file and creating a pull request to confirm that the template appears automatically. section 8.5.2
API design proposal
An API governance team can require a pull request to reference the work ticket describing the feature. The template reminds the designer to provide that reference and explain the change, while API linting, breaking-change checks, and code-owner approval enforce separate review criteria. section 8.14 section 8.3
A template is a prompt, not a validator: submitters can ignore it, and it does not verify whether entered information is accurate. Keep questions short, then use automated checks and required domain-expert approval for enforceable policy. section 8.8 section 8.3
## Why is this change needed? ## What is the scope of this change? ## Checklist - [ ] Have you run tests locally?
A compact template combines rationale, scope, and a local-test checklist without overloading the submitter. section 8.5.2
