Skip to content
Sarj Repo Standards

pull-request-template-sections

Include required PR template headings.

warning Enable rule repository/documentation/pull-request-template-sections Rule source Rule JSON

Examples

The PR template has no Test evidence heading

Before — rejected · warning 
{"required":["What & why","Test evidence"],"template":"## What & why\n"}
After — preferred 
{"required":["What & why","Test evidence"],"template":"## What & why\n\n## Test evidence\n"}
More cases 2

There is no PR template

Before — rejected · warning 
{"required":["What & why"],"template":null}
After — preferred 
{"required":["What & why"],"template":"## What & why\n"}

No required headings need no template

Before — rejected · warning 
{"required":["Test evidence"],"template":null}
After — preferred 
{"required":[],"template":null}

Enable this rule

Add the stable ID to enabled_rules in your tracked .repo-standards/repository.toml:

enabled_rules = ["repository/documentation/pull-request-template-sections"]

This selects only this rule. To retain the defaults, also include repository/artifacts/untyped-javascript and repository/artifacts/bespoke-iac-verifiers, along with any existing IDs. Omitted or empty selections use the defaults. Setup and staged checks