Contributing#

Environment#

The following steps can be followed to set up a development environment.

Clone the project and enter the directory:

git clone https://github.com/RatulMaharaj/predictable.git
cd predictable

Install hatch
```
pipx install hatch
```
Enter the default environment (this will activate the default virtual environment and install the project in editable mode).
```
hatch shell default
```

You can now proceed to make changes to the project.

Testing#

This project uses pytest for testing purposes. The tests can be found in the tests directory. Tests will run after every commit (locally) and on every push (using github actions) but can also be run manually using:

hatch run test

Linting#

This project is linted using ruff and formatted with black. The linting and formatting can be run manually using:

hatch run lint

hatch run format

Documentation#

The documentation for this project can be found in the docs directory. The documentation is created using mkdocs and can be viewed locally using:

hatch run docs:serve

The docs can also be built for deployment using:

hatch run docs:build