We use GitHub issues for bug reports and feature requests.
Make an issue with your feature description;
We shall discuss the design and its implementation details;
Once we agree that the plan looks good, go ahead and implement it.
Goto GitHub issues;
Pick an issue and comment on the task that you want to work on this feature;
If you need more context on a specific issue, please ask, and we will discuss the details.
Once you finish implementing a feature or bugfix, please send a Pull Request.
If you are not familiar with creating a Pull Request, here are some guides:
Contribution best practices¶
brew install bash # for MacOS users pip install -r requirements/requirements.txt -r requirements/requirements-dev.txt
Break your work into small, single-purpose updates if possible. It’s much harder to merge in a large change with a lot of disjoint features.
Submit the update as a GitHub pull request against the master branch.
Make sure that you provide docstrings for all your new methods and classes.
Add new unit tests for your code.
Check the codestyle
Make sure that your code passes the unit tests
Do not forget to check the codestyle for your PR with
catalyst-make-codestyle && catalyst-check-codestyle
Make sure to have your python packages complied with requirements/requirements.txt and requirements/requirements-dev.txt to get codestyle run clean.
Do not forget to check that your code passes the unit tests
Check that you have written working docs¶
The command requires Sphinx and some sphinx-specific libraries. If you don’t want to install them, you may make a catalyst-dev container
make docker-dev docker run \\ -v `pwd`/:/workspace/ \\ catalyst-dev:latest \\ bash -c "make check-docs"
To build docs add environment variable REMOVE_BUILDS=0¶
REMOVE_BUILDS=0 make check-docs
or through docker
docker run \\ -v `pwd`/:/workspace/ \\ catalyst-dev:latest \\ bash -c "REMOVE_BUILDS=0 make check-docs"
The docs will be stored in builds/ folder.