Skip to content

Latest commit

 

History

History
43 lines (29 loc) · 919 Bytes

File metadata and controls

43 lines (29 loc) · 919 Bytes

Contributing Guide

Thank you for contributing to Star OpenAPI.

  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
  2. Running the tests

    set pythonpath=. 
    # or export pythonpath=.
    pytest tests
  3. Running the ruff

    ruff check star_openapi tests examples
  4. Running the ty

    ty check star_openapi
  5. Building the docs

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

    mkdocs serve