Skip to content

Commit

Permalink
Fix merge issue
Browse files Browse the repository at this point in the history
  • Loading branch information
bdukes authored May 1, 2018
1 parent f3eee07 commit fbe4b9f
Showing 1 changed file with 7 additions and 9 deletions.
16 changes: 7 additions & 9 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,25 +24,23 @@ so that we can have a chance of keeping on top of things.
* To quickly create a topic branch based on development; `git checkout -b my_contribution development`
* Make commits of logical units.
* Check for unnecessary whitespace with `git diff --check` before committing.
* Make sure your pull request description tags the GitHub issue ID, so it is clear what issue you have fixed.
* Make sure your commit messages are in the proper format.

````
Make the example in CONTRIBUTING imperative and concrete
```
The Pull Request Description
* Make sure you tag the GitHub Issue ID so it is clear what issue you have fixed.
```
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, indicating what
happens to the code when this commit is applied. The body describes the
behavior without the patch, why this is a problem, and how the patch
fixes the problem when applied. Finally, a reference to the GitHub issue
is made for enable better tracking.
Fixes #123 #345
````
Expand Down

0 comments on commit fbe4b9f

Please # to comment.