diff options
| author | Victor Woeltjen <victor.woeltjen@nasa.gov> | 2015-09-25 20:47:41 +0300 |
|---|---|---|
| committer | Victor Woeltjen <victor.woeltjen@nasa.gov> | 2015-09-25 20:47:41 +0300 |
| commit | 4f0e8ada2f393a6759347af4f376b8d91f9b738b (patch) | |
| tree | 1dc9d2ecdb2ed7dbc6342efa09ff27e95f6ca505 /CONTRIBUTING.md | |
| parent | f3aceb1644f2ce872e0f3a41b0e8fb76cb7608cc (diff) | |
[Process] Loosen commit message standards
Loosen commit message standards, to minimize clutter in GitHub
issues. nasa/openmctweb#145.
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 3 |
1 files changed, 3 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5f2fb18d8..fcd1504ef 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. |