Demo Developer Workflow Standards PR Template

• Ensures reviewers get consistent information.
• Speeds up reviews by highlighting tests, breaking changes, and required checklist items.
• Encourages contributors to follow project standards.

​

Prerequisites

• Push access to the repository (or create a branch and open a PR).
• Basic Git knowledge (creating branches, committing, pushing).

​

Steps

1. Create the template file
   Create a file at .github/pull_request_template.md in the repository root. GitHub recognizes files in the .github folder as repository-level templates.
2. Add the PR template contents
   Paste the following content into .github/pull_request_template.md. This example covers description, change type, testing, and a checklist that your maintainers can adapt to the project’s workflow.

## Description
<!-- Summary of changes, problem solved, and motivation -->
Fixes #<issue-number>

## Type of Change
- [ ] Bug fix
- [ ] New feature
- [ ] Breaking change
- [ ] Chore / Refactoring
- [ ] Documentation update

## How Has This Been Tested?
<!-- Describe tests, environment, or steps to reproduce -->

## Checklist
- [ ] My code follows project style guidelines.
- [ ] I have self-reviewed my code.
- [ ] I have updated documentation.
- [ ] I have added tests that prove my fix is effective.

3. Commit the change
   You can commit directly via the GitHub web UI (if allowed) or use the command line. Example workflow using a branch:

git checkout -b add/pr-template
git add .github/pull_request_template.md
git commit -m "chore: add pull request template"
git push origin add/pr-template

4. Open a pull request (if you pushed a branch) or confirm the template is applied (if you committed to main)
   When a contributor opens a new PR, GitHub will pre-populate the PR description with the template contents. Note that the template does not create a PR automatically; it only populates the PR description when one is opened.

​

Template sections explained

​

Verifying the template

• Open a new PR in the repository to confirm that the template content appears in the PR description.
• Update the template over time as review requirements change (e.g., add automated checklist items linked to CI jobs or test results).

• The PR template file serves as the default content for new PR descriptions; it does not open PRs automatically.
• If you have multiple templates, consider using GitHub’s issue and PR template chooser (see links below).

​

Links and references

• GitHub: Pull request template docs — https://docs.github.com/en/github/building-a-strong-community/creating-a-pull-request-template
• GitHub: About issue and pull request templates — https://docs.github.com/en/github/building-a-strong-community/about-issue-and-pull-request-templates