Skip to content

Latest commit

 

History

History
42 lines (28 loc) · 945 Bytes

CONTRIBUTING.md

File metadata and controls

42 lines (28 loc) · 945 Bytes

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

    pip install -U flask pydantic
  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