Contributing

Contributing Guide

Thank you for contributing to Flask OpenAPI3.

1. Create a new issue
2. Fork and Create a pull request

Before submitting pr, you need to complete the following steps:

1. Install requirements

   uv sync --upgrade --all-extras --all-groups
   

2. Running the tests

   set pythonpath=. 
   # or export pythonpath=.
   pytest tests
   

3. Running the ruff

   ruff check flask_openapi3 tests examples
   

4. Running the mypy

   mypy flask_openapi3
   

5. Building the docs

   Serve the live docs with Material for MkDocs, and make sure it's correct.

   mkdocs serve