diff options
| author | KHobbits <rob@khobbits.co.uk> | 2013-02-20 01:39:04 +0000 |
|---|---|---|
| committer | KHobbits <rob@khobbits.co.uk> | 2013-02-20 01:39:04 +0000 |
| commit | a1779da98631945e21c1389f501ce152817d93f3 (patch) | |
| tree | 4abbbc3e9d74077dee1aef3090bfc83bdab43154 | |
| parent | 6cc71b8114a41de0c716780a40ea9409e54ffc92 (diff) | |
| download | Essentials-a1779da98631945e21c1389f501ce152817d93f3.tar Essentials-a1779da98631945e21c1389f501ce152817d93f3.tar.gz Essentials-a1779da98631945e21c1389f501ce152817d93f3.tar.lz Essentials-a1779da98631945e21c1389f501ce152817d93f3.tar.xz Essentials-a1779da98631945e21c1389f501ce152817d93f3.zip | |
Readme cleanup.
| -rw-r--r-- | README.markdown | 18 |
1 files changed, 17 insertions, 1 deletions
diff --git a/README.markdown b/README.markdown index 1913e1ba1..81cb76976 100644 --- a/README.markdown +++ b/README.markdown @@ -11,6 +11,22 @@ Recommended NetBeans plugins: * Git * PMD & FindBugs ( http://kenai.com/projects/sqe/pages/Home ) + +Commit Guidelines +----------------- + +Commits should fall into one of 3 areas: + +[Feature] Commits which are features should start with '[Feature]' and followed by a quick summary on the top line, followed by some extra details in the commit body. + +[Fix] Commits which fix bugs, or minor improvements to existing features should start with '[Fix]' and followed by a quick summary on the top line, followed by some extra details in the commit body. + +Commits which fix bugs caused by previous commits (since last release), or otherwise make no functionality changes, should have no prefix. These will not be added to the project change log. + +Coding Guidelines +----------------- + + Please follow the format guidelines that are saved in the project properties. Windows users, please read this: http://help.github.com/line-endings/ @@ -20,4 +36,4 @@ To build all jars, select the BuildAll project and build that. You'll find all j If you create pull requests, always make them for the master branch. -The essentials bug tracker can be found at http://www.assembla.com/spaces/essentials/tickets
\ No newline at end of file +The essentials bug tracker can be found at http://www.assembla.com/spaces/essentials/tickets |