Home

Contributing to unet

This document provides guidelines for contributions to cytounet.

Kinds of contribution

• Typo fixes
• Documentation enhancements
• Pull requests

Fixing typos and enhancing documentation

To fix typos and/or grammatical errors, please edit the corresponding .py or .md file that generates the documentation.

Please also update the docs using sphinx

Pull Requests

• Please raise an issue for discussion and reproducibility checks at issues

• Once the bug/enhancement is approved, please create a Git branch for the pull request.

• Make changes and ensure that builds are passing the necessary checks on Travis.

• Update changelog.md to reflect the changes made.

• Do the following:

# The Makefile here is Windows specific

# root of project
python -m m2r README.md --overwrite
python -m m2r changelog.md --overwrite
# copy changelog and README or get their diff and copy it to docs/source
# TODO
cd ./README* ./changelog* docs/source

cd docs
# build docs
sphinx-build source build
# use make on *nix or if you have make on Windows
make.bat html

Please note that the 'pyfdc' project is released with a Contributor Code of Conduct. By contributing to this project, you agree to abide by its terms.

See also for a guide on Sphinx documentation.