From 4f0e8ada2f393a6759347af4f376b8d91f9b738b Mon Sep 17 00:00:00 2001 From: Victor Woeltjen Date: Fri, 25 Sep 2015 10:47:41 -0700 Subject: [PATCH] [Process] Loosen commit message standards Loosen commit message standards, to minimize clutter in GitHub issues. nasa/openmctweb#145. --- CONTRIBUTING.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5f2fb18d84..fcd1504ef0 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -238,6 +238,9 @@ Commit messages should: * Contain a reference to a relevant issue number in the body of the commit. * This is important for traceability; while branch names also provide this, you cannot tell from looking at a commit what branch it was authored on. + * This may be omitted if the relevant issue is otherwise obvious from the + commit history (that is, if using `git log` from the relevant commit + directly leads to a similar issue reference) to minimize clutter. * Describe the change that was made, and any useful rationale therefore. * Comments in code should explain what things do, commit messages describe how they came to be done that way.