Skip to content

Commit 47e9bda

Browse files
committed
Readme: added info regarding what a commit message should include
1 parent d1c8b70 commit 47e9bda

File tree

1 file changed

+14
-1
lines changed

1 file changed

+14
-1
lines changed

README.md

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,9 +28,22 @@ When submitting a pull request for review there are a few important steps you ca
2828
3. Limit the scope to one Issue/Feature
2929
4. Small focused commits, ideally less than 10 to 20 lines
3030
5. Avoid merge commits (see Pro Git's [chapter on rebasing](http://git-scm.com/book/ch3-6.html), section [Rebasing](#rebasing) below)
31-
31+
6. Add the appropriate commit message (see below)
3232
Taken together, the above reduces the effort that's required of the contributor reviewing your pull request.
3333

34+
### Commit messages
35+
36+
Commit messages should include four components:
37+
* The WHERE - a single word that categorizes and provides context for the commit and its message, followed by a colon (:). This is typically the name of the plugin being worked on, but sometimes might be something like Build: or Docs:
38+
* The WHAT - a sufficient summary of the fix or change made (example: modified the foo to no longer bar), followed by a period (.)
39+
* The WHY #Num - the ticket number with a #sign so Trac creates a hyperlink (example: #1234), followed by a hyphen/dash (-)
40+
* The WHY Name - the name of the ticket. Notice this is different than summary of the fix. This is a short description of the issue (example: dialog: IE6 crashed when foo is set to bar)
41+
42+
Combined into one, here's a full example:
43+
"Dialog: modified the foo to no longer bar. Fixed #1234 - dialog: IE6 crashed when foo is set to bar"
44+
\WHERE/:\------------- WHAT -------------/.\ WHY #Num /-\---------------- WHY Name ----------------/
45+
46+
3447
## Build/Customization
3548

3649
Currently the library is shipped on the jQuery CDN/download as a single monolithic JavaScript file that depends on jQuery Core (not included) and a similarly bundled CSS file. For users we support the following build targets:

0 commit comments

Comments
 (0)