Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

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.
  • Loading branch information...
commit cf04e5ef3512e270ef88c13dbc68c402638b028f 1 parent 9862940
@jeffmccune jeffmccune authored
Showing with 10 additions and 3 deletions.
  1. +10 −3 CONTRIBUTING.md
View
13 CONTRIBUTING.md
@@ -31,10 +31,17 @@ top of things.
* Make sure your commit messages are in the proper format.
````
- (#Ticket Number) What you are changing with this commit
+ (#99999) Make the example in CONTRIBUTING imperative and concrete
- Describe what happened before. Describe the change in behavior that this
- commit makes.
+ 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.
````
* Make sure you have added the necessary tests for your changes.
Please sign in to comment.
Something went wrong with that request. Please try again.