Skip to content

Commit

Permalink
Update example commit
Browse files Browse the repository at this point in the history
  • Loading branch information
bdukes authored May 1, 2018
1 parent 4aa5cb3 commit 09cdf25
Showing 1 changed file with 5 additions and 7 deletions.
12 changes: 5 additions & 7 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,20 +27,18 @@ so that we can have a chance of keeping on top of things.
* Make sure your commit messages are in the proper format.

````
#123 Make the example in CONTRIBUTING imperative and concrete
The 123 is the GitHub issue ID which needs to be tagged to properly track
the issues history.
Make the example in CONTRIBUTING imperative and concrete
Without this patch applied the example commit message in the CONTRIBUTING
document is not a concrete example. This is a problem because the
contributor is left to imagine what the commit message should look like
based on a description rather than an example. This patch fixes the
problem by making the example concrete and imperative.
The first line is a real life imperative statement with a ticket number
from our issue tracker. The body describes the behavior without the patch,
why this is a problem, and how the patch fixes the problem when applied.
The first line is a real life imperative statement. The body describes
the behavior without the patch, why this is a problem, and how the patch
fixes the problem when applied. Finally, there is a reference to the
issue number that the commit addresses. Fixes #2044
````

* For bonus points run and add unit tests
Expand Down

0 comments on commit 09cdf25

Please # to comment.