From 2762088c6426b4e88da8d23a04e80dc3c2a9e069 Mon Sep 17 00:00:00 2001 From: JC Staudt <24510452+jcstaudt@users.noreply.github.com> Date: Thu, 31 May 2018 16:55:34 -0700 Subject: [PATCH] Commit msg now has bash formatting --- CONTRIBUTING.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 639f8834..b2aa5a36 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -43,10 +43,12 @@ Always write a clear log message for your commits. Simply saying "Update" is not adequate to understand what change(s) you made. One-line messages are fine for small changes, but bigger changes should look like this: +```bash $ git commit -m "A brief summary of the commit (max 50 chars) > > An optional paragraph describing what changed and its impact." - +``` + Please ensure that all of your commits are atomic (one feature per commit). This helps prevent tons of headaches digging through code in an attempt to reproduce your steps.