Skip to content

fix PR template sectioning#8

Merged
PSchmiedmayer merged 2 commits into
mainfrom
lukas/pr-template
Jul 11, 2026
Merged

fix PR template sectioning#8
PSchmiedmayer merged 2 commits into
mainfrom
lukas/pr-template

Conversation

@lukaskollmer

Copy link
Copy Markdown
Contributor

fix PR template sectioning

♻️ Current situation & Problem

this has actually been bugging me for ages: the last section in the PR template (code of conduct) is using a higher heading level than the other sections (3 vs 2); causing it to appear as if it were a sub-section of the previous section (Testing).
see eg this PR (which was created using the old template).

the proposed fix here is to bring the PR template in line with what we get from the issue templates:

  • we now use level-3 headings everywhere
  • we also no longer duplicate the PR title into the PR description

⚙️ Release Notes

  • updated PR template to bring it in sync with the layout/formatting we have for issues

📚 Documentation

n/a

✅ Testing

n/a

Code of Conduct & Contributing Guidelines

By creating and submitting this pull request, you agree to follow our Code of Conduct and Contributing Guidelines:

Signed-off-by: Lukas Kollmer <hey@lukaskollmer.de>
Signed-off-by: Lukas Kollmer <hey@lukaskollmer.de>
@lukaskollmer lukaskollmer self-assigned this Jul 11, 2026
@lukaskollmer lukaskollmer added enhancement New feature or request github_actions Pull requests that update GitHub Actions code labels Jul 11, 2026
@coderabbitai

coderabbitai Bot commented Jul 11, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 77e73ada-4533-49f0-a2a7-c075256b7656

📥 Commits

Reviewing files that changed from the base of the PR and between 11aed94 and 665671d.

📒 Files selected for processing (1)
  • .github/pull_request_template.md

📝 Walkthrough

Walkthrough

The pull request template updates the heading levels for “Current situation & Problem,” “Release Notes,” “Documentation,” and “Testing” from ## to ###. It also adjusts blank-line spacing around these sections while preserving the existing instructional bullet text.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title is concise and directly reflects the PR template sectioning change.
Description check ✅ Passed The description follows the template and includes all required sections, with reasonable placeholder entries for documentation and testing.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@lukaskollmer

Copy link
Copy Markdown
Contributor Author

@PSchmiedmayer this obviously is a very subjective thing, so feel free to reject if you prefer the current setup

@PSchmiedmayer PSchmiedmayer 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.

Looks good 🚀

@PSchmiedmayer
PSchmiedmayer merged commit 5484c49 into main Jul 11, 2026
6 checks passed
@PSchmiedmayer
PSchmiedmayer deleted the lukas/pr-template branch July 11, 2026 17:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request github_actions Pull requests that update GitHub Actions code

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants