Contributing to CHAMPAGNE¶

TODO -- describe gitflow, require PRs...

Use pre-commit hooks¶

Pre-commit can automatically format your code, check for spelling errors, etc. every time you commit.

Install pre-commit if you haven't already, then run pre-commit install to install the hooks specified in .pre-commit-config.yaml. Pre-commit will run the hooks every time you commit.

Versions¶

Increment the version number following semantic versioning¹ in the VERSION file.

Changelog¶

Keep the changelog up to date with all notable changes in CHANGELOG.md².

VS code extensions¶

If you use VS code, installing nf-core extension pack is recommended.

Installation¶

For testing and debugging, We recommend installing the dev version of champagne to a user-specific location.

git clone https://github.com/CCBR/CHAMPAGNE
mkdir -p ~/bin/champagne
pip install ./CHAMPAGNE -t ~/bin/champagne
export PATH="$HOME/bin/champagne/bin:$PATH"