DISPATCH
README.md
1 # README #
2 
3 ### What is this repository for? ###
4 
5 * This is the repository for the pubclic version of the DISPATCH code framework
6 * Version 1.0
7 * [Markdown demo](https://bitbucket.org/tutorials/markdowndemo)
8 
9 ### How to set up a connection to this repository ###
10 
11 * If you have write access: simple updates in general go to the alpha branch for testing
12  * For larger, non-trivial edits, work on a feature branch and use pull requests.
13 * If you have read access: fork this repository and use pull requests to contribute.
14 
15 ### Contribution guidelines ###
16 
17 * If you want your pull request to have a chance, you need to merge from `alpha` before making the pull request.
18 
19 ### Commit codes ###
20 
21 When committing changes to this repository, please use the following three-letter codes at the beginning of your commit messages:
22 
23 * DEV: code development (incl. additions and deletions)
24 * ORG: organisational, no changes to functionality
25 * BUG: bug with significant impact on previous work -- `grep`-ing should give restricted list
26 * FIX: fixes that occur during development, but which have essentially no impact on previous work
27 * VIS: visualisation
28 * OPT: optimisation
29 * DBG: debugging
30 * SYN: typos and misspellings (including simple syntax error fixes)
31 * WIP: snapshot/work in progress
32 * CLN: tidying of the code, including removal of obsolete features, experiments, etc.
33 * DOC: Changes or additions to the documentation