Contributing

We encourage contributions to DESERT_Underwater from the community.

Fork the DESERT_Underwater repository on Github.
Clone your fork or add the remote if you already have a clone of the repository.

git clone [email protected]:yourusername/DESERT_Underwater.git

or

git remote add mine_remote [email protected]:yourusername/DESERT_Underwater.git

Create a branch for your improvements, bug fix, new modules, etc. To maintain consinstency throughout the repository a coding style is enforced by the maintainers, which can be found in the coding-rules document.

git checkout -b your-branch

Make your changes and commit. Use a clear and descriptive commit message. To maintain a well documented trace of changes a committing style is also enforced by the maintainers, which can be found in the commit-rules document.

git commit -m 'Module A: added this wonderful feature!' -m 'This feature allows to stop the time and fix wrong things. User can then restart the time. Fix #Issue'

Push to your fork of the repository and then send a pull-request through Github.

git push mine some-topic-branch

A community maintainer will review your pull request and merge it into the main repository or send you feedback.