Contributing¶
The whole development workflow is managed by a Makefile. conda is the only prerequisite to start developing. Other required tools will be installed in the development conda environment.
Manage environment:
make init
to create the conda environment and do some other initialization.make up
to update the conda environment.source ./activate
to activate the conda environment.
Edit code:
make fmt
to format source code consistently. Certain rules are forced automatically so we humans don’t need to care that much.make lint
until all pass.make test
until all pass.
Edit doc:
make doc
to build and open the doc for review.
Release:
Change
__version__
(ingizio.__about__
) from dev to production. From1.0.0.dev0
to1.0.0
for example. Update changelog and commit.make build
.make publish-test
to test publish on TestPyP.make publish
to publish officially on PyPI.Change
__version__
back to dev. From1.0.0
to1.1.0.dev0
for example. Commit.