Thank you for choosing to contribute in PyCaret. There are a ton of great open-source projects out there, so we appreciate your interest in contributing to PyCaret.
There is always a room for improvement in documentation. We welcome all the pull requests to fix typo / improve grammar or semantic structuring of documents. Here are few documents you can work on:
If you would like to help in working on open issues. Lookout for following tags: good first issue, help wanted, and open for contribution.
Follow installation instructions to first create a virtual environment. Then, install the development version of the package:
pip install -e .[test]We use black (version 22.12.0) and isort (latest version)
for code formatting. Make sure to run isort pycaret and black pycaret
from the home directory before creating the PR. Failing to do so can result
in a failed build, which would prevent the adoption of your code.
Install development version of the package with additional extra dependencies required for unit testing:
pip install -e .[test]We use pytest for unit testing.
To run tests, except skipped ones (search for @pytest.mark.skip decorator over test functions), run:
pytest pycaretWe use sphinx to build our documentation and readthedocs to host it. The source files can be found in docs/source/. The main configuration file for sphinx is conf.py and the main page is index.rst.
To build the documentation locally, you need to install a few extra dependencies listed in
docs/source/requirements.txt:
pip install -r docs/source/requirements.txtTo build the website locally, run:
sh make.shYou can find the generated files in the docs/build/ folder. To view the website, open docs/build/index.html with your preferred web browser.