Skip to content

Conversation

@coolreader18
Copy link
Collaborator

@coolreader18 coolreader18 commented Mar 7, 2025

Description of Changes

This has been annoying me for months haha. This turns the instructions for each section into <!-- comments -->, so that they don't show up in the rendered description if they're not removed, and it makes it much more obvious to see when a section isn't filled out because there's nothing there. Also removed the default X from the testing checkbox, so that the PR author has to actually check it to show they've done it. Also, maybe the "API and ABI breaking changes" should also just be a comment?

Testing

  • Tested how it renders. The below is the new template, rendered but unedited:

Description of Changes

API and ABI breaking changes

Expected complexity level and risk

Testing

@bfops bfops added release-any To be landed in any release window no runtime change This change does not affect the final binaries labels Mar 10, 2025
@bfops
Copy link
Collaborator

bfops commented Mar 21, 2025

This seems good to me, but I think @cloutiertyler will probably want to take a look.

@cloutiertyler
Copy link
Contributor

Oh absolutely, this has been annoying me too, but I couldn't think of a way to fix it.

Copy link
Collaborator

@bfops bfops left a comment

Choose a reason for hiding this comment

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

In that case, sold!

@coolreader18 coolreader18 added this pull request to the merge queue Apr 1, 2025
Merged via the queue into master with commit f2a4abb Apr 1, 2025
16 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

no runtime change This change does not affect the final binaries release-any To be landed in any release window

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants