Skip to content

Commit 7c8ada9

Browse files
authored
github: Use alternative heading syntax in pull request template (#36)
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 `git` CLI. 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.
1 parent 28325a1 commit 7c8ada9

File tree

1 file changed

+8
-4
lines changed

1 file changed

+8
-4
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,19 @@
1-
### Motivation
1+
Motivation
2+
----------
23

34
_[Explain here the context, and why you're making that change. What is the problem you're trying to solve.]_
45

5-
### Modifications
6+
Modifications
7+
-------------
68

79
_[Describe the modifications you've made.]_
810

9-
### Result
11+
Result
12+
------
1013

1114
_[After your change, what will change.]_
1215

13-
### Test Plan
16+
Test Plan
17+
---------
1418

1519
_[Describe the steps you took, or will take, to qualify the change - such as adjusting tests and manual testing.]_

0 commit comments

Comments
 (0)