Skip to content

Fix uneven heading levels in pull_request_template.md #19599

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Fix uneven heading levels in pull_request_template.md #19599

wants to merge 2 commits into from
+1 −1

Conversation

@kpreid
Copy link
Contributor

@kpreid kpreid commented Jun 12, 2025

Objective

  • Make the heading levels in the pull request consistent with their relationship to each other.

Solution

  • Change the “Objective” heading from level 1 to level 2 to be equal to the other headings.

@alice-i-cecile alice-i-cecile added D-Trivial Nice and easy! A great choice to get started with Bevy A-Meta About the project itself labels Jun 12, 2025
@alice-i-cecile alice-i-cecile enabled auto-merge June 12, 2025 17:54
@alice-i-cecile alice-i-cecile added the S-Ready-For-Final-Review This PR has been approved by the community. It's ready for a maintainer to consider merging it label Jun 12, 2025
@IceSentry
Copy link
Contributor

IceSentry commented Jun 12, 2025 •
edited
Loading

If everything uses the same heading should they all use level 1 then?

That would also fix the CI failing. That or tell CI that no level 1 in pull requests is fine

@alice-i-cecile alice-i-cecile added S-Waiting-on-Author The author needs to make changes or address concerns before this can be merged and removed S-Ready-For-Final-Review This PR has been approved by the community. It's ready for a maintainer to consider merging it labels Jun 12, 2025
@alice-i-cecile
Copy link
Member

alice-i-cecile commented Jun 12, 2025

That would also fix the CI failing. That or tell CI that no level 1 in pull requests is fine

CI would instead complain about multiple L1 headings 😂 I think we need to change the rules to allow this one way or another, and I think that L2 is a nicer choice here.

@alice-i-cecile alice-i-cecile added A-Build-System Related to build systems or continuous integration D-Straightforward Simple bug fixes and API improvements, docs, test and examples and removed D-Trivial Nice and easy! A great choice to get started with Bevy labels Jun 12, 2025
@kpreid
Copy link
Contributor Author

kpreid commented Jun 12, 2025

Every PR page already has its level 1 heading provided by GitHub.

@alice-i-cecile alice-i-cecile added S-Ready-For-Final-Review This PR has been approved by the community. It's ready for a maintainer to consider merging it S-Needs-Help The author needs help finishing this PR. and removed S-Waiting-on-Author The author needs to make changes or address concerns before this can be merged S-Ready-For-Final-Review This PR has been approved by the community. It's ready for a maintainer to consider merging it labels Sep 4, 2025
@alice-i-cecile
Copy link
Member

alice-i-cecile commented Sep 4, 2025 •
edited
Loading

That lint warning about the need for the L1 heading is flatly wrong. We need a way to silence it (ideally just for this file) before we can merge.

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

Reviewers

@james7132 james7132 james7132 approved these changes

@alice-i-cecile alice-i-cecile alice-i-cecile approved these changes

Assignees

No one assigned

Labels

A-Build-System Related to build systems or continuous integration A-Meta About the project itself D-Straightforward Simple bug fixes and API improvements, docs, test and examples S-Needs-Help The author needs help finishing this PR.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@kpreid @IceSentry @alice-i-cecile @james7132