1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
|
## Contributing Guide
Thank you for contributing to Flask OpenAPI3.
1. [Create a new issue](https://github.com/luolingchun/flask-openapi3/issues/new)
2. [Fork and Create a pull request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork)
Before submitting pr, you need to complete the following steps:
1. Install requirements
```bash
uv sync --upgrade --all-extras --all-groups
```
2. Running the tests
```bash
set pythonpath=.
# or export pythonpath=.
pytest tests
```
3. Running the ruff
```bash
ruff check flask_openapi3 tests examples
```
4. Running the mypy
```bash
mypy flask_openapi3
```
5. Building the docs
Serve the live docs with [Material for MkDocs](https://github.com/squidfunk/mkdocs-material), and make sure it's correct.
```bash
mkdocs serve
```
|
