spiel/docs/contributing.md

Contributing Guide

!!! info "Spiel is open to contributions!"

- [Report bugs and request features](https://github.com/JoshKarpel/spiel/issues)
- [General discussion](https://github.com/JoshKarpel/spiel/discussions)
- [Pull requests](https://github.com/JoshKarpel/spiel/pulls)

Development Environment

Spiel uses:

• poetry to manage development dependencies.
• pre-commit to run various linters and formatters.
• pytest for testing and mypy for static type-checking.
• mkdocs with the Material theme for documentation.

Initial Setup

To set up a local development environment after cloning the repository:

1. Install poetry.
2. Run poetry shell to create a virtual environment for spiel and spawn a new shell session with that virtual environment activated. In the future you'll run poetry shell again to activate the virtual environment.
3. Run poetry install to install Spiel's dependencies.
4. Run pre-commit install to configure pre-commit's integration with git. Do not commit without pre-commit installed!

Running Tests and Type-Checking

Run pytest to run tests.

Run mypy to check types.

Building the Docs Locally

To build the docs and start a local web server to view the results of your edits with live reloading, run

mkdocs serve

from the repository root.