Contributing¶
Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.
You can contribute in many ways:
Types of Contributions¶
Report Bugs¶
Report bugs at https://github.com/xinp-hub/pydiggs/issues.
If you are reporting a bug, please include:
- Your operating system name and version.
- Any details about your local setup that might be helpful in troubleshooting.
- Detailed steps to reproduce the bug.
Fix Bugs¶
Look through the GitHub issues for bugs. Anything tagged with "bug" and "help wanted" is open to whoever wants to implement it.
Implement Features¶
Look through the GitHub issues for features. Anything tagged with "enhancement" and "help wanted" is open to whoever wants to implement it.
Write Documentation¶
pydiggs could always use more documentation, whether as part of the official pydiggs docs, in docstrings, or even on the web in blog posts, articles, and such.
Submit Feedback¶
The best way to send feedback is to file an issue at https://github.com/xinp-hub/pydiggs/issues.
If you are proposing a feature:
- Explain in detail how it would work.
- Keep the scope as narrow as possible, to make it easier to implement.
- Remember that this is a volunteer-driven project, and that contributions are welcome :)
Development Setup¶
In a dev container (recommended)¶
The repository ships a dev container (.devcontainer/) with uv, Python 3.11–3.14 and the
GitHub CLI, all pinned. Open it in GitHub Codespaces from the badge, or
locally with Dev Containers: Reopen in Container. Nothing is installed on your machine,
so any computer with a browser gives you the same environment, and uv sync has already
run when it opens.
Commit signing in Codespaces: open
github.com/settings/codespaces, turn on GPG
verification and add this repository. GitHub then signs commits made in your codespaces
and shows them as Verified; no signing key is copied into the container. To run the
same checks as CI inside it: uv run ruff check ., uv run mypy, uv run pytest.
On your own machine¶
Ready to contribute? Here's how to set up pydiggs for local development.
-
Fork the
pydiggsrepo on GitHub. -
Clone your fork locally:
-
Install uv if you haven't already:
-
Sync the environment (reads
uv.lock): -
Create a branch for local development:
-
Make your changes locally. The project uses:
-
pytest for testing
- ruff for lint and format
- mypy for type checking
- pre-commit for automated checks (optional locally)
Install pre-commit hooks:
- When you're done making changes:
- Run tests:
- Lint and format:
-
Type check:
-
Commit your changes and push your branch to GitHub:
-
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:
- Add docstrings to new functions/classes
- Update the documentation under
docs/ - Add the feature to the list in README.md
- The pull request should work for Python 3.11 and above.
- Check that all tests pass in the GitHub Actions CI pipeline.
- Sign off every commit with
git commit -s. TheSigned-off-byline certifies the Developer Certificate of Origin 1.1, and your contribution is licensed under Apache-2.0 like the rest of the project. TheDCO sign-offcheck fails a pull request with a commit that lacks it; see CONTRIBUTING.md for the terms and for how to fix existing commits. - Sign your commits cryptographically as well.
masteronly accepts commits that GitHub shows as Verified, so an unsigned pull request cannot be merged even when it is approved and green. SSH signing is the simplest setup: register an SSH key on GitHub as a signing key, then rungit config --global gpg.format ssh, pointuser.signingkeyat the public key, and setcommit.gpgsigntotrue.
How Pull Requests Are Merged¶
Every pull request gets a merge policy check that puts it in one of three risk tiers.
The tier is worked out from the change itself — who made it, which files it touches and
what the diff contains — never from an automated reviewer's opinion.
- Tier 0 — Dependabot updates that change only dependency versions: patch and minor updates, plus 0.x minor updates of development-only dependencies. These merge on their own once CI passes.
- Tier 1 — small changes by the maintainers to source code, tests or documentation. An automated reviewer reads the change, and if it approves and CI passes, the pull request merges on its own.
- Tier 2 — everything else: changes to CI workflows, packaging or dependencies by hand, GitHub Actions updates, larger changes, and every pull request from a fork. A maintainer reviews and merges these.
Merging never releases the package: release tags and PyPI uploads always need a
maintainer. A merge to master does rebuild and redeploy this documentation site.
Documentation¶
To build and view the documentation locally:
Then visit http://127.0.0.1:8000 in your web browser.
Four checks keep the documentation true to the code:
- Generated pages.
docs/facts.md(extras, Python range and the--helpof everypydiggscommand), the operations table indocs/capabilities.mdanddocs/convert-mapping.mdare written from the code. After changing an extra, a command-line option or an operation, runuv run python scripts/docs_gen.pyand commit the result;uv run python scripts/docs_gen.py --check(andtests/test_docs.py) fails on a stale page. The--helptext is captured on Python 3.11, the oldest supported version. - Examples run.
tests/test_docs.pyruns everypythonblock inREADME.mdanddocs/, top to bottom, one namespace per file, in a scratch directory where the file names the guides use (site.xml,site.ags,BH-01.xml) are real files; add a name toDOC_FILESthere when a new example needs another. A block that cannot run in a test gets<!-- skip: next "reason" -->on the line above it. - Docs follow the API. The
docs follow the APIcheck fails a pull request that adds, removes or changes public API, console scripts or extras without a change todocs/,README.mdorCHANGELOG.md(docs/facts.mddoes not count). Theno-docs-neededlabel is the maintainer's override: a maintainer adds it, and an agent never does. - Published versions. The site has two trees:
latest/is built from the newestvX.Y.Ztag anddev/frommaster, with a notice on everydev/page. The history page isCHANGELOG.mditself, embedded; there is no second copy to keep in step.
Testing¶
To run a subset of tests:
To run tests with coverage:
Type Checking¶
The project uses type hints and mypy (strict) for type checking:
Code Style¶
The project follows ruff's formatter and linter. Style is enforced with: * ruff (lint + format) * GitHub Actions CI
Deploying¶
A reminder for the maintainers on how to deploy:
- Update
CHANGELOG.mdand bumpversioninpyproject.toml. - Tag a release (
vX.Y.Z) and push the tag (HG3 / HG4 in the FORGE process). - GitHub Actions
publish.ymlbuilds with a fixedSOURCE_DATE_EPOCHand publishes to PyPI via Trusted Publishing (OIDC; no API token). Thepypienvironment requires a human reviewer.