Firstly, thank you for taking the time to contribute.

The following section describes how you can contribute to the openapi-core project on GitHub.

• Check whether your issue already exists in the Issue tracker.
• Make sure it is not a support request or question better suited for the Discussion board.

• Include a clear title.
• Describe your runtime environment with the exact versions you use.
• Describe the exact steps to reproduce the problem, including minimal code snippets.
• Describe the behavior you observed after following the steps, including console outputs.
• Describe the expected behavior and why, including links to documentation.

Install Poetry by following the official installation instructions. Optionally (but recommended), configure Poetry to create a virtual environment in a folder named .venv within the root directory of the project:

poetry config virtualenvs.in-project true

To create a development environment and install the runtime and development dependencies, run:

poetry install

Then enter the virtual environment created by Poetry:

poetry shell

The project uses static checks with the fantastic pre-commit. Every change is checked on CI, and if it does not pass the tests, it cannot be accepted. If you want to check locally, run the following command to install pre-commit.

To enable pre-commit checks for commit operations in git, enter:

pre-commit install

To run all checks on your staged files, enter:

pre-commit run

To run all checks on all files, enter:

pre-commit run --all-files

Pre-commit check results are also attached to your PR through integration with GitHub Actions.

Contrib integrations are tested in CI against framework version variants and Python versions. The matrix source of truth is:

• .github/workflows/integration-tests.yml

When changing integration compatibility, update both:

• dependency constraints in pyproject.toml
• integration variants in .github/workflows/integration-tests.yml
• information in docs/integrations and README.md