summaryrefslogtreecommitdiffstats
path: root/README.markdown
diff options
context:
space:
mode:
authorKHobbits <rob@khobbits.co.uk>2013-02-20 01:39:04 +0000
committerKHobbits <rob@khobbits.co.uk>2013-02-20 01:39:04 +0000
commit64ee6b7914759c60f2162bd727ce596d04093ce0 (patch)
treeddf20ec413e888b0a94fd774a0e82d7b1273f34b /README.markdown
parent6ae6c51dc05582c56a820e2f6317eff232952d70 (diff)
downloadEssentials-64ee6b7914759c60f2162bd727ce596d04093ce0.tar
Essentials-64ee6b7914759c60f2162bd727ce596d04093ce0.tar.gz
Essentials-64ee6b7914759c60f2162bd727ce596d04093ce0.tar.lz
Essentials-64ee6b7914759c60f2162bd727ce596d04093ce0.tar.xz
Essentials-64ee6b7914759c60f2162bd727ce596d04093ce0.zip
Readme cleanup.
Diffstat (limited to 'README.markdown')
-rw-r--r--README.markdown18
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