Skip to content

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

    1
    pip install -U flask pydantic
    
  2. Running the tests

    1
    2
    3
    set pythonpath=. 
    # or export pythonpath=.
    pytest tests
    
  3. Running the flake8

    1
    flake8 flask_openapi3 tests examples
    
  4. Running the mypy

    1
    mypy flask_openapi3
    
  5. Building the docs

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

    1
    mkdocs serve