Development Guide¶

Get Started!¶

Ready to contribute? Here’s how to set up gym-saturation for local development. Please note this documentation assumes you already have Git installed and ready to go.

Fork the gym-saturation on GitHub.

Clone your fork locally:

cd git_URL
git clone git@github.com:YOUR_NAME/gym-saturation.git

Install [poetry](https://python-poetry.org/docs/#installing-with-the-official-installer)

Now you can install all the things you need for development:

poetry install --all-groups
# install Vampire binary
wget https://github.com/vprover/vampire/releases/download/v4.7/vampire4.7.zip -O vampire.zip
unzip vampire.zip
# then use vampire_z3_rel_static_HEAD_6295 as an argument or add it to $PATH
# install iProver binary
wget https://gitlab.com/api/v4/projects/39846772/jobs/artifacts/2023.04.10/download?job=build-job -O iprover.zip
unzip iprover.zip
# then use iproveropt

poetry will also create a virtual environment in a .venv subfolder. To activate it:
```
poetry env activate
```
Create a branch for local development:
```
git checkout -b name-of-your-bug-fix-or-feature
```
Now you can make your changes locally.
When you’re done making changes, check that your changes pass code quality checks.
```
ruff format
ruff check
pydoclint gym_saturation
pyrefly check
```
You can also do these checks automatically on each commit. To activate this option:
```
pre-commit install
```
The next step would be to run the test cases. gym-saturation uses pytest and all the existing tests are doctest.
```
coverage run -m pytest
coverage report -m
```
If your contribution is a bug fix or new feature, you may want to add a test to the existing test suite. If possible, do it by doctest, not a dedicates test case file.

Commit your changes and push your branch to GitHub:

git add .
git commit -m "Your detailed description of your changes."
git push origin name-of-your-bug-fix-or-feature

Submit a pull request through the GitHub website.

Pull Request Guidelines¶

Before you submit a pull request, check that it meets these guidelines:

The pull request should include tests.
If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring, and add new classes or functions to a relevant file in the doc/api folder. To build the doc locally:
```
cd doc
make html
```
The pull request should work for Python 3.10, 3.11, 3.12, and 3.13. Check https://github.com/inpefess/gym-saturation/pulls and make sure that the CI checks pass for all supported Python versions.