chore: remove HTML comments and inline guide #15613
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What does this PR try to resolve?
The HTML comments in the PR template, after this repo migrated to GitHub merge queue, often show up in the merge commit message when people forgot to delete it.
This PR removes those, as they are only important for people never look at the contributor guide. We keep one link to the guide though at the top of the template.
It also moves the entire template out of HTML comments, so it is more obvious for maintainers to see what will be in the merge commit message.
The “Additional information” paragraph is removed, as I observed it is seldom used.
How to test and review this PR?
Copy and paste the PR template into the PR description preview, and see if it satisfies your eyes.