This document describes the HydrOffice Sound Speed Library and Manager (2019.2). For the source code, go here.

3.1. How to contribute

Every open source project lives from the generous help by contributors that sacrifice their time and this is no different.

3.1.1. Public Repositories

The source code is available on both GitHub and BitBucket.

To propose changes to Sound Speed Manager, you can follow the common Fork & Pull Request workflow. If you are not familiar with such a workflow, a good starting point may be this short tutorial.

3.1.2. Coding Style

To make participation as pleasant as possible, this project adheres to the Code of Conduct by the Python Software Foundation.

Here are a few hints and rules to get you started:

  • Add yourself to the AUTHORS.txt file in an alphabetical fashion. Every contribution is valuable and shall be credited.

  • If your change is noteworthy, add an entry to the changelog.

  • No contribution is too small; please submit as many fixes for typos and grammar bloopers as you can!

  • Don’t ever break backward compatibility.

  • Always add tests and docs for your code. This is a hard rule; patches with missing tests or documentation won’t be merged. If a feature is not tested or documented, it does not exist.

  • Obey PEP 8 and PEP 257.

  • Write good commit messages.

  • Ideally, collapse your commits, i.e. make your pull requests just one commit.

Note

If you have something great but aren’t sure whether it adheres – or even can adhere – to the rules above: please submit a pull request anyway! In the best case, we can mold it into something, in the worst case the pull request gets politely closed. There’s absolutely nothing to fear.

Thank you for considering to contribute! If you have any question or concerns, feel free to reach out to us (see Credits).