Contributing
Contributing Guide⚓︎
Thank you for contributing to Flask OpenAPI3.
Before submitting pr, you need to complete the following steps:
-
Install requirements
1
pip install -U -r requirements-dev.txt
-
Running the tests
1 2 3
set pythonpath=. # or export pythonpath=. pytest tests
-
Running the flake8
1
flake8 flask_openapi3 tests examples
-
Running the mypy
1
mypy flask_openapi3
-
Building the docs
Serve the live docs with Material for MkDocs, and make sure it's correct.
1
mkdocs serve