diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 739653e1e7c..0364ee470f1 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -27,10 +27,7 @@ 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 @@ -38,9 +35,10 @@ so that we can have a chance of keeping on top of things. 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