Contributing

January 29, 2025 ยท View on GitHub

As an open source project, pdoc welcomes contributions of all forms. If you would like to bring the project forward, please consider contributing in the following areas:

  • Maintenance: We are incredibly thankful for individuals who are stepping up and helping with maintenance. This includes (but is not limited to) helping out other users, creating minimal examples for existing bug reports, updating documentation, fixing minor bugs that have recently been reported, reviewing pull requests, or picking up stale ones.
  • Code Contributions: We actively mark issues that we consider are good first contributions. If you intend to work on a larger contribution to the project, please come talk to us first. We are very careful not to introduce any feature creep.

Development Setup

To get started hacking on pdoc, please install uv. Then, do the following:

git clone https://github.com/mitmproxy/pdoc.git
cd pdoc
uv run pdoc --help

Testing

If you've followed the procedure above, you already have all the development requirements installed, and you can run the basic test suite with tox:

uv run tox

Please ensure that all patches are accompanied by matching changes in the test suite. The project strictly maintains 100% test coverage.

Fixing Snapshot Tests

pdoc makes heavy use of snapshot tests, which compare the rendered output with a stored copy in the test/testdata directory. These tests are very useful to catch regressions, but also have a tendency to break quickly. You can overwrite failing snapshots tests by running

uv run test/test_snapshot.py

Alternatively, CI will automatically update all snapshots.

Documentation

Please check docs/README.md for instructions.

Release Process

If you are the current maintainer of pdoc, you can perform the following steps to ship a release:

  1. Invoke the release workflow from the GitHub UI: https://github.com/mitmproxy/pdoc/actions/workflows/release.yml
  2. The spawned workflow run will require manual deploy confirmation on GitHub twice: https://github.com/mitmproxy/pdoc/actions