From 744bb1b1bee203a9ff8532192eb4d5ad5cd7f8f9 Mon Sep 17 00:00:00 2001 From: Josh Cummings Date: Fri, 9 Mar 2018 12:53:58 -0700 Subject: [PATCH] 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. --- CONTRIBUTING.md | 1 + 1 file changed, 1 insertion(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8d4b6f2d21..9600bb51cc 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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- at the end if this fixes a GitHub issue +5. Avoid markdown, including back-ticks identifying code # Run all tests prior to submission