Contributing#

AntroPy is an open-source project and contributions are welcome! Here’s how you can help.

Reporting bugs#

If you find a bug, please open an issue on the GitHub repository with:

  • A clear description of the problem

  • A minimal reproducible example

  • Your Python and AntroPy version

Submitting a pull request#

  1. Fork the repository and clone your fork locally.

  2. Install in editable mode with test dependencies using uv:

    git clone https://github.com/<your-username>/antropy.git
cd antropy
uv pip install --group=test --editable .

  3. Create a branch for your changes:

    git checkout -b my-feature

  4. Make your changes, add tests, and verify everything passes:

    pytest --verbose

  5. Check code style with ruff:

    uvx ruff check
uvx ruff format --check

  6. Open a pull request against the master branch.

Updating the documentation#

The documentation is built with Sphinx. To build it locally:

  1. Install the documentation dependencies:

    uv pip install --group=docs --editable .

  2. Build the HTML docs:

    make -C docs clean
make -C docs html

  3. Open docs/build/html/index.html in your browser to preview the result.

When you open a pull request, a docs CI job automatically builds the documentation and uploads the result as a GitHub Actions artifact. To verify the rendered docs from a PR:

  1. Go to the PR on GitHub and click on the Checks tab.

  2. Open the Build documentation and upload as artifact to GitHub Actions workflow run.

  3. Click Summary in the left sidebar, then scroll down to the Artifacts section.

  4. Download the docs-artifact zip file and open index.html in your browser.

Questions#

If you have questions, please use GitHub Discussions rather than opening an issue.