Skip to content

Commit 744bb1b

Browse files
jzheauxrwinch
authored andcommitted
Advisory to avoid markdown in commit messages
Today, @rwinch and I were discussing the merits of leaving commit messages free of formatting hints, like back-ticks. Adding this bullet-point brings things into line with expectations.
1 parent 776b378 commit 744bb1b

File tree

1 file changed

+1
-0
lines changed

1 file changed

+1
-0
lines changed

CONTRIBUTING.md

+1
Original file line numberDiff line numberDiff line change
@@ -180,6 +180,7 @@ Fixes gh-123
180180
2. Do not end the subject line with a period
181181
3. In the body of the commit message, explain how things worked before this commit, what has changed, and how things work now
182182
3. Include Fixes gh-<issue-number> at the end if this fixes a GitHub issue
183+
5. Avoid markdown, including back-ticks identifying code
183184

184185
# Run all tests prior to submission
185186

0 commit comments

Comments
 (0)