CRM-20965 - PULL_REQUEST_TEMPLATE - Change header notation #10784
Conversation
This file contains 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
If you use the `#` notation for headers, the Github CLI (`hub pull-request`) would filter out those lines as comments. Using the `---` notation should provide that.
|
Seems fine & obviously safe. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Overview
The Github CLI (
hub pull-request) uses#to indicate comment lines, e.g.Before
Headers are marked with
##, which conflicts with the comment#.After
Headers are marked with
-----, which does not conflict.Comments
hub(2.3.0-pre10). The current stable release ofhub(v2.2.9) does not seem to respectPULL_REQUEST_TEMPLATEat all.----lines match the width of the titles. (That's common in Markdown.) However, that looks weird when you fill out the template on a web-browser. (In a browser, the width of-may not match your other characters.). So I just went with a really long----line.