Skip to content

docs: Use consistent heading levels in PR template - #8155

Open
pratikmankawde wants to merge 1 commit into
developfrom
pratik/pr-template-heading-levels
Open

docs: Use consistent heading levels in PR template#8155
pratikmankawde wants to merge 1 commit into
developfrom
pratik/pr-template-heading-levels

Conversation

@pratikmankawde

Copy link
Copy Markdown
Contributor

High Level Overview of Change

The PR template's section headings were split across two levels: High Level Overview of Change, Before / After, Test Plan and Future Tasks were ##, while Context of Change and API Impact were ###. 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.md are 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: an h3 with no h2 parent 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.md passes — 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.

@pratikmankawde
pratikmankawde requested a review from a team as a code owner September 1, 2026 14:49

@xrplf-ai-reviewer xrplf-ai-reviewer Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Simple docs-only change that promotes two ### headings to ## in the PR template for heading-level consistency. The diff matches the description exactly, and no other issues are introduced.

@pratikmankawde
pratikmankawde requested a review from a team September 1, 2026 14:50
@mvadari

mvadari commented Sep 1, 2026

Copy link
Copy Markdown
Contributor

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.

@pratikmankawde

Copy link
Copy Markdown
Contributor Author

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, High Level Overview of Change does not look like the parent of Context of Change. Since High level means a short desc. Context then gives the background. API Change is completely unrelated to those two. Ex.: A change in consensus.cpp does not need to mean an api change. So, I think these headings stand on their own.

@mathbunnyru mathbunnyru left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think separate sections are slightly clearer

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟢 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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants