docs: Use consistent heading levels in PR template - #8155
Conversation
|
I always saw the heading levels structured like that to be intentional, not an accident, as context/API change is really just more details about the high-level changes. |
@mvadari To me, |
mathbunnyru
left a comment
There was a problem hiding this comment.
I think separate sections are slightly clearer
There was a problem hiding this comment.
🟢 Approval recommended
The change is a simple, consistent Markdown heading-level adjustment with no behavioral impact and no issues found.
Pull request overview
This PR updates the repository’s pull request template to make all top-level sections use consistent heading levels, improving visual consistency and the document outline for tooling and accessibility.
Changes:
- Promote “Context of Change” from
###to##. - Promote “API Impact” from
###to##.
File summaries
| File | Description |
|---|---|
| .github/pull_request_template.md | Normalizes all template section headings to the same level (##) for consistent rendering and outline structure. |
Review details
- Files reviewed: 1/1 changed files
- Comments generated: 0
- Review effort level: Lite
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
High Level Overview of Change
The PR template's section headings were split across two levels:
High Level Overview of Change,Before / After,Test PlanandFuture Taskswere##, whileContext of ChangeandAPI Impactwere###. This change promotes those two to##, so every section of the template sits at the same level.Context of Change
All six sections of
.github/pull_request_template.mdare peers — none is nested inside another, and the template's own commented-out sections (## Before / After,## Test Plan,## Future Tasks) already used##. The two###headings were the only outliers, which GitHub renders at a visibly smaller size than their siblings. The effect is cosmetic in every PR opened from the template, and it also breaks the document outline: anh3with noh2parent above it is not a valid nesting for a screen reader or for any tool that builds a table of contents from heading depth.Nothing in the template's guidance text or checkboxes changes, so authors see the same prompts and the same four API-impact boxes as before.
API Impact
No public API,
libxrpl, or peer protocol impact. The change touches one repository metadata file and no source, so there is no consensus-visible behaviour and nothing to recompile.Test Plan
pre-commit run --files .github/pull_request_template.mdpasses — prettier, cspell, trailing-whitespace and end-of-file hooks all report Passed, so the file is still canonically formatted markdown. This PR's own description is written against the updated template, so its rendered headings are the verification that all six sections now display uniformly.