Skip to content

Contributing to dyce

You can help by filing new issues. Please try to avoid duplicates. For beefs, rants, ideas, recipes, etc., consider starting or joining a discussion.

Hacking quick-start

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
# Basic setup
git clone https://github.com/posita/dyce.git
cd dyce
uv venv --clear --prompt "$( basename "${PWD}" )" --relocatable
uv sync
uv run pre-commit install

# Run tests with coverage using the current environment
uv run pytest --cov

# Run tests across configured Python versions
uv run tox

# Run linters, type checkers, and other validators via pre-commit
uv run pre-commit run --all-files --hook-stage pre-push

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
# Basic setup
git clone https://github.com/posita/dyce.git
cd dyce
python3 -m venv --prompt dyce .venv
. .venv/bin/activate
pip install --requirements requirements-dev.txt
pre-commit install

# Run tests with coverage using the current environment
pytest --cov

# Run tests across configured Python versions
tox

# Run linters, type checkers, and other validators via pre-commit
pre-commit run --all-files --hook-stage pre-push

Submission guidelines

Consider submitting a pull request with a fix, if you have one. Required: If it is not already present, please add your name to the LICENSE file to assent to the inclusion of your contribution. Optionally include your email, GitHub username, website address, or other contact information as desired. If you want feedback on a work-in-progress, consider “mentioning” me (@posita), and describe specifically how I can help.

Provide tests where feasible and appropriate. Unit tests live in tests. At the very least, existing tests should not fail.

If at all possible, please author commit messages and PR descriptions yourself. LLM-produced prose tends to lack concision, clarity, and character.