-
Notifications
You must be signed in to change notification settings - Fork 3
[DOCS, FIX] edit pre-commit hooks, update FastAPI-fastkit guides #39
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
Updates developer tooling/docs so local pre-commit hooks no longer depend on system-installed formatters/linters, and moves template-change inspection feedback into a PR-triggered GitHub Actions workflow (aligning with issue #38).
Changes:
- Refactors
.pre-commit-config.yamlto run Black/Isort/Mypy vialanguage: pythonhook envs (no morelanguage: systemscripts). - Adds “Template PR Inspection” GitHub Actions workflow to validate changed templates and comment results on PRs.
- Updates contributing/development documentation to reflect the revised workflows and commands.
Reviewed changes
Copilot reviewed 7 out of 7 changed files in this pull request and generated 12 comments.
Show a summary per file
| File | Description |
|---|---|
env.example |
Simplifies translation env example; removes optional token/provider notes. |
docs/en/contributing/template-creation-guide.md |
Documents that template PRs are automatically inspected via CI. |
docs/en/contributing/development-setup.md |
Updates dev setup and pre-commit guidance; adds env var notes. |
docs/en/contributing/code-guidelines.md |
Updates documented pre-commit configuration example and removes flake8 mention. |
CONTRIBUTING.md |
Adds CI template inspection description; updates pre-commit checklist. |
.pre-commit-config.yaml |
Reworks hooks to use isolated Python environments with tool deps. |
.github/workflows/template-pr-inspection.yml |
New PR workflow that inspects changed templates and comments results. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Requesting Merging
Description
edit pre-commit hooks & update FastAPI-fastkit dev guides to current version
Type of Change
Test Environment
local, M1 Mac, Windows 11
Major Changes
fastapi_project_templateScreenshots (optional)
N/A
Etc
close #38