github: Use alternative heading syntax in pull request template #36
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The Git CLI ignores commit message lines starting with # as comments, so editing commits causes heading lines starting ### to be lost.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Motivation
The Git CLI ignores commit message lines starting with # as comments,
so editing commits causes heading lines starting ### to be lost.
Modifications
Change the pull request template to use underlines instead of ###.
Result
Headings will not be lost when commits are edited using the
gitCLI.Headings will now be H2 rather than H3, because there is no alternative
syntax for H3.
Test Plan
Submitted this PR using the new syntax.