Contributor guide¤

Welcome to the Griffe contributor guide! If you are familiar with Python tooling, development, and contributions to open-source projects, see the TL;DR at the end, otherwise we recommend you walk through the following pages:

• Environment setup
• Management commands
• Development workflow

Regular contributors might be interested in the following documents that explain Griffe's design and inner workings:

• Architecture

If you are unsure about what to contribute to, you can check out our issue tracker to see if some issues are interesting to you.

TL;DR¤

• Install Python, uv and direnv
• Fork, clone, and enter repository
• Run direnv allow and make setup
• Checkout a new branch
• Edit code, tests and/or documentation
• Run make format check test docs to check everything
• Commit, push, open PR