Development Guide#
Welcome, and thank you for your interest in contributing to Qrisp!
This guide collects the engineering standards and conventions that help keep the codebase maintainable and welcoming to new contributors. It is intended to complement (not replace) the existing project documentation and GitHub issue tracker.
The goal is to enable incremental improvements to code quality, test coverage, and documentation alongside ongoing feature development. You do not need to work through every section in order as each page stands on its own.
Topic |
Description |
|---|---|
Set up a local development environment and verify the baseline test suite. |
|
Static analysis, code style, and type annotations. |
|
How to write and structure tests using pytest. |
|
Building the docs locally and writing correct docstrings. |
|
Opening issues and pull requests, asking for help, and common mistakes to avoid. |
|
Writing a tutorial or example for your implementation. |
|
First issues to tackle and feature requests. |