Skip to content

Commit

Permalink
Updated contribution guide for pull requests to include the GitHubiss…
Browse files Browse the repository at this point in the history
…ue ID in the PR and no longer needing the jira ID in the commit
  • Loading branch information
Andrew Hoefling committed May 1, 2018
1 parent c00fc10 commit b173701
Showing 1 changed file with 9 additions and 2 deletions.
11 changes: 9 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,11 +24,16 @@ 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 commit messages are in the proper format.

````
(DNN-####) Make the example in CONTRIBUTING imperative and concrete
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
Expand All @@ -38,6 +43,8 @@ so that we can have a chance of keeping on top of things.
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.
Fixes #123 #345
````

* For bonus points run and add unit tests
Expand Down

0 comments on commit b173701

Please # to comment.