Skip to content

Contributing

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

    1
    uv sync
    
  2. Running the tests

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

    1
    ruff check star_openapi tests examples
    
  4. Running the mypy

    1
    mypy star_openapi
    
  5. Building the docs

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

1
2
3
```bash
mkdocs serve
```