File tree Expand file tree Collapse file tree 5 files changed +21
-5
lines changed
src/fastapi_fastkit/fastapi_project_template Expand file tree Collapse file tree 5 files changed +21
-5
lines changed Original file line number Diff line number Diff line change @@ -10,6 +10,16 @@ assignees: ''
1010
1111> After making issue, please refer it on your commit message
1212
13+ ## Before making PR
14+
15+ - [ ] I checked [ CONTRIBUTING.md] ( CONTRIBUTING.md ) document and [ FastAPI template README] ( ../../src/fastapi_fastkit/fastapi_project_template/README.md )
16+ - [ ] I checked all template files use .py-tpl extension
17+ - [ ] I checked ` setup.py ` includes FastAPI-fastkit dependency
18+ - [ ] I checked security requirements met
19+ - [ ] I checked template's tests implemented and must pass
20+ - [ ] I checked template's documentation is necessary
21+ - [ ] I checked how to inspect FastAPI template using ` inspector.py `
22+
1323## Summary
1424
1525> Please briefly explain what kind of template it is or what kind of update you want to make
Original file line number Diff line number Diff line change 2929 uses : actions/setup-python@v4
3030 with :
3131 python-version : ${{ matrix.python-version }}
32+ - name : Setup PDM
33+ uses : pdm-project/setup-pdm@v4
3234 - name : Install dependencies
3335 run : pdm install
36+ - name : Run tests
37+ run : pdm run pytest
Original file line number Diff line number Diff line change 3030 name : test
3131 entry : bash scripts/test.sh
3232 language : system
33+ types : [python]
3334 pass_filenames : false
3435
3536ci :
Original file line number Diff line number Diff line change @@ -69,7 +69,7 @@ bash scripts/lint.sh
6969
7070### Making commits
7171
72- Use these tags in commit messages :
72+ Use these tags in PR title :
7373
7474- [ FEAT] : New feature
7575- [ FIX] : Bug fix
@@ -82,8 +82,11 @@ Use these tags in commit messages:
8282Example:
8383
8484``` bash
85- git commit -m ' [FEAT] Add new FastAPI template for microservices'
86- git commit -m ' [FIX] Fix virtual environment activation in Windows'
85+ # PR title example 1
86+ ' [FEAT] Add new FastAPI template for microservices'
87+
88+ # PR title example 2
89+ ' [FIX] Fix virtual environment activation in Windows'
8790```
8891
8992#### Pre-commit
@@ -212,7 +215,6 @@ template-name/
2122153 . Pre-submission Checklist:
213216 - [ ] All files use .py-tpl extension
214217 - [ ] FastAPI-fastkit dependency included
215- - [ ] README.md follows template
216218 - [ ] Security requirements met
217219 - [ ] Tests implemented and passing
218220 - [ ] Documentation complete
Original file line number Diff line number Diff line change @@ -64,7 +64,6 @@ Follow these steps when adding a new template:
64644 . Pre-PR checklist:
6565 - [ ] All files use .py-tpl extension
6666 - [ ] FastAPI-fastkit dependency included
67- - [ ] README.md follows template
6867 - [ ] Security requirements met
6968 - [ ] Tests implemented and passing
7069 - [ ] Documentation complete
You can’t perform that action at this time.
0 commit comments