Contributing¶

Feedback¶

We welcome feedback! To ask a question, report a bug, or suggest a feature, please open a new thread on our issue tracker.

Contributing Code¶

Please read this guide if you plan to contribute code.

Git Workflow¶

You should use a forking workflow to contribute to pytest-issues. In brief, this means you should make a fork of the upstream repository, create a feature branch on your fork, and then submit pull requests from your feature branch to the main branch of the upstream.

Installation¶

We use uv to manage the development ecosystem, and you can use uv to implement a developer installation.

Install uv
Clone the repository
Navigate to the root of the cloned project. For example: cd path/to/pytest-issues
Run uvx --from poethepoet poe setup

This will install pytest-issues along with a number of developer tools, and will also set up various pre-commit hooks.

Scripts¶

We use poethepoet to implement various commonly-used developer scripts. Run poe at the command line for an overview of available scripts.