Essentials/README.markdown

Essentials Development Readme
=============================

The official repository is at:
https://github.com/essentials/Essentials

We use NetBeans 7 for development.

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/
The default line ending is LF.

To build all jars, select the BuildAll project and build that. You'll find all jars inside the dist/lib folder of the BuildAll project.

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
Added developer readme and settings. 2011-06-07 23:01:28 +02:00			`Essentials Development Readme`
			`=============================`

			`The official repository is at:`
			`https://github.com/essentials/Essentials`

			`We use NetBeans 7 for development.`

			`Recommended NetBeans plugins:`

			`* Git`
			`* PMD & FindBugs ( http://kenai.com/projects/sqe/pages/Home )`

Readme cleanup. 2013-02-20 02:39:04 +01:00			`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`
			`-----------------`


Updated readme about format guidelines. 2011-11-30 00:54:44 +01:00			`Please follow the format guidelines that are saved in the project properties.`
Edited README.markdown via GitHub 2011-07-24 23:25:12 +02:00
			`Windows users, please read this: http://help.github.com/line-endings/`
			`The default line ending is LF.`
Added developer readme and settings. 2011-06-07 23:01:28 +02:00
Edited README.markdown via GitHub 2011-07-03 00:12:43 +02:00			`To build all jars, select the BuildAll project and build that. You'll find all jars inside the dist/lib folder of the BuildAll project.`

Updating Readme 2011-10-04 16:56:43 +02:00			`If you create pull requests, always make them for the master branch.`

Readme cleanup. 2013-02-20 02:39:04 +01:00			`The essentials bug tracker can be found at http://www.assembla.com/spaces/essentials/tickets`