Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
27 lines (20 loc) · 1.56 KB

CONTRIBUTING.md

File metadata and controls

27 lines (20 loc) · 1.56 KB

Contributing

Please note we have a code of conduct; please follow it in all your interactions with the project.

Pull Request Process

  1. Ensure any install or build dependencies are removed before the end of the layer when doing a build.
  2. Update the README.md with details of changes to the interface; this includes new environment variables, exposed ports, valid file locations and container parameters.
  3. Increase the version numbers in any examples files and the README.md to the new version that this Pull Request would represent. The versioning scheme we use is SemVer.
  4. You may merge the Pull Request once you have the sign-off of the repository administrator, or if you do not have permission to do that, you may request the adminstrator to merge it for you.

Issue Report Process

  1. Go to the project's issues.
  2. Select the template that better fits your issue.
  3. Read the instructions carefully and write within the template guidelines.
  4. Submit it and wait for support.

Accreditation

Research publications that cite this repository may not recognise individual contributors, rather the repository as a whole and/or specific releases. This means that no contributor is to expect individual citations for their contributions to this repository. However, you will still be recognised as a contributor if you make any merged changes to the repository, and will recieve the same credit as a non-research-related repository. We deeply value contributors and they are what make the open source community incredible.