Contributing.rst

Contributing

Please add @pafonta as a reviewer if your Pull Request modifies core.

Setup

git clone https://github.com/BlueBrain/nexus-forge
pip install --editable kgforge[dev]

Checks before committing

tox

Styling

PEP 8, PEP 257, and PEP 20 must be followed.

Releasing

# Setup
pip install --upgrade pip setuptools wheel twine

# Checkout
git checkout master
git pull upstream master

# Check
tox

# Tag
git tag -a v<x>.<y>.<z> HEAD
git push upstream v<x>.<y>.<z>

# Build
python setup.py sdist bdist_wheel

# Upload
twine upload dist/*

# Clean
rm -R build dist *.egg-info

Generating locally the documentation

# Install sphinx-build and related packages
pip install .[docs]

# cd to the docs directory
cd docs

# Generate the docs
sphinx-build -T -W --keep-going -b html -d _build/doctrees -c ./source -D language=en ./source _build/html