CONTRIBUTING.md

Contributing to CNVkit

Thank you for your interest in contributing to CNVkit!

Quick links

• Report bugs / request features: GitHub Issues
• Ask usage questions: Biostars CNVkit forum
• User documentation: ReadTheDocs

Getting started

git clone https://github.com/YOUR_USERNAME/cnvkit.git
cd cnvkit
conda env create -f environment-dev.yml   # brings in R + DNAcopy
conda activate cnvkit
pip install -e '.[test]'
pre-commit install                        # run quality checks on commit
pytest test/                              # confirm the suite passes

Full developer guide

Environment setup, code style and conventions, testing, the pull request process, and the maintainer workflows for building documentation and Docker images are all documented in the Development and contributing guide (source: doc/development.rst).

License

By contributing to CNVkit, you agree that your contributions will be licensed under the Apache License 2.0.