Browse Source

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.
pull/5102/head
Josh Cummings 8 years ago committed by Rob Winch
parent
commit
744bb1b1be
  1. 1
      CONTRIBUTING.md

1
CONTRIBUTING.md

@ -180,6 +180,7 @@ Fixes gh-123 @@ -180,6 +180,7 @@ Fixes gh-123
2. Do not end the subject line with a period
3. In the body of the commit message, explain how things worked before this commit, what has changed, and how things work now
3. Include Fixes gh-<issue-number> at the end if this fixes a GitHub issue
5. Avoid markdown, including back-ticks identifying code
# Run all tests prior to submission

Loading…
Cancel
Save