mirror of https://github.com/JoshKarpel/spiel
You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
43 lines
1.6 KiB
Markdown
43 lines
1.6 KiB
Markdown
# 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`](https://python-poetry.org) to manage development dependencies.
|
|
- [`pre-commit`](https://pre-commit.com) to run various linters and formatters.
|
|
- [`pytest`](https://docs.pytest.org) for testing and [`mypy`](https://mypy-lang.org) for static type-checking.
|
|
- [`mkdocs`](https://www.mkdocs.org) with the [Material theme](https://squidfunk.github.io/mkdocs-material) for documentation.
|
|
|
|
### Initial Setup
|
|
|
|
To set up a local development environment after cloning the repository:
|
|
|
|
1. [Install `poetry`](https://python-poetry.org/docs/#installation).
|
|
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
|
|
|
|
Use `pytest` to run tests.
|
|
|
|
Types will automatically be checked as part of the test suite run;
|
|
`mypy` can also be run standalone.
|
|
|
|
### 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
|
|
```bash
|
|
mkdocs serve
|
|
```
|
|
from the repository root.
|