Skip to content

Commit

Permalink
[issue/23] Added new guidelines to committing section of readme.
Browse files Browse the repository at this point in the history
issue numbers!

ref #23
  • Loading branch information
callumacrae committed Feb 16, 2012
1 parent a2fc92f commit 2fbc4ef
Showing 1 changed file with 13 additions and 1 deletion.
14 changes: 13 additions & 1 deletion README.md
Expand Up @@ -58,12 +58,14 @@ the coding standards used in there. A basic summary:
Only a few guidelines here. Commits should use the following syntax:

```
Basic description of the commit.
[issue/#] Basic description of the commit.
Longer description of what the commit does and how it does it. Can wrap
multiple lines. The commit message should not be any longer than 79 characters
wide at any point - you editor should do this for you, anyway. Second line
should remain empty.
ref #ticketnumber
```

I should be able to tell exactly what the commit does without reading the
Expand All @@ -72,6 +74,16 @@ diff - a commit message can never be too long!
If you notice an error in a previous commit which you haven't pushed yet,
amend it instead of making a new commit.

So an example commit:

```
[issue/19] Fixed a bug where blank wiki command would link nowhere.
Now it links to the wiki main page.
ref #19
```


### Contributors ###

Expand Down

0 comments on commit 2fbc4ef

Please sign in to comment.