kurtsansom / dispatch

README

What is this repository for?

• This is the repository for the pubclic version of the DISPATCH code framework
• Version 1.0
• Markdown demo

How to set up a connection to this repository

• If you have write access: simple updates in general go to the alpha branch for testing
  • For larger, non-trivial edits, work on a feature branch and use pull requests.
• If you have read access: fork this repository and use pull requests to contribute.

Contribution guidelines

• If you want your pull request to have a chance, you need to merge from alpha before making the pull request.

Commit codes

When committing changes to this repository, please use the following three-letter codes at the beginning of your commit messages:

• DEV: code development (incl. additions and deletions)
• ORG: organisational, no changes to functionality
• BUG: bug with significant impact on previous work -- grep-ing should give restricted list
• FIX: fixes that occur during development, but which have essentially no impact on previous work
• VIS: visualisation
• OPT: optimisation
• DBG: debugging
• SYN: typos and misspellings (including simple syntax error fixes)
• WIP: snapshot/work in progress
• CLN: tidying of the code, including removal of obsolete features, experiments, etc.
• DOC: Changes or additions to the documentation