Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Updated contributing guide for GitHub issues #2046

Merged
merged 1 commit into from
May 1, 2018
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 9 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,20 +24,25 @@ 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.

````
(DNN-####) Make the example in CONTRIBUTING imperative and concrete
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, 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
````

* For bonus points run and add unit tests
Expand Down