When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.
- Branch from the
dev
branch. If you are implementing a feature name itfeature/name_of_feature
, if you are implementing a bugfix name itbug/issue_name
. If they are associated with a specific issue, you may use the issue number in place of the name. - Update the README.rst and other documentation with details of major changes to the interface, this includes new environment variables, useful file locations and container parameters.
- Once you are ready for review please open a pull/merge request to the
dev
branch. - You may merge the Pull/Merge Request in once you have the sign-off of two maintainers.
- If you are merging
dev
tomaster
, you must increment the version number in the VERSION file to the new version that this Pull/Merge Request would represent. The versioning scheme we use is SemVer.
- We name variables using few nouns in lowercase, e.g.
mapping_names
orincrement
. - We name functions using verbs in lowercase, e.g.
map_variables_to_names
orchange_values
. - We use the numpydoc format for documenting features using docstrings.
- When we want to release the package we will request a formal review for any non-minor changes.
- The review process follows a similar process to ROpenSci.
- Reviewers will be requested from associated communities.
- Only once reviewers are satisfied, will the
dev
branch be released.