Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
26 lines (18 loc) · 1004 Bytes

CONTRIBUTING.md

File metadata and controls

26 lines (18 loc) · 1004 Bytes

Contributing

Code style: black

Coding standards

Coding standards applied and adhered to in this project are based on PEP 8 guidelines. Black is used to ensure that coding standards are met.

Version control of Jupyter notebooks

To version-control Jupyter notebooks avoiding that each run is interpreted as new version of the notebook, cd into the project root directory and type

nbstripout --install

This ensures that whenever you commit a Jupyter notebook to the repo, the output will be stripped automatically. The result is that only the code and markdown are versioned.

How to create a new release?

  1. Run all unit tests. No test shall fail.
  2. ...
  3. Commit and push all changes.
  4. Create a new tag vYYYY.D.D on GitHub.
  5. Create a new release branch release/vYYYY.D.D from the new tag.