Your contribution to this project is very welcome. It is however important to stay within some basic house rules.
- Create an issue for each contribution (bug, new code, improvements, etc). It is beneficial to make check lists in the issue. It makes it possible to track progress.
- All new development shall be in branches
- The branches are created based on an issue and shall be named issue###_shortname.
- Merging into master is only done by @anderskaestner. Your steps prepare a merge:
- Merge master into your branch.
git checkout <mybranch> git merge master
- Rebuild the code. Fix issues
- Run unit tests. Fix failed tests
- Merge master into your branch.
- Merges are done using pull requests, which are reviewed by @anderskaestner before merging.
- Implement unit tests for your contributions
- New code
- Debugging; add tests in existing test classes or implement a new test class if needed.
- Test data is provided in test data repository
Use the following styles in the code:
- Braces
if (a==b) { // the code }
- Function names: To be written
- Class names: To be written
- Variables: To be written
This document is still under construction. Please don't hesitate to contact @anderskaestner if something is unclear