Skip to content

Conversation

@bnbong
Copy link
Owner

@bnbong bnbong commented Jan 24, 2026

Requesting Merging

Description

edit pre-commit hooks & update FastAPI-fastkit dev guides to current version

Type of Change

  • BUG FIX
  • ADDING NEW TEMPLATE
  • FEATURE ADDED/UPDATED
  • HOTFIX
  • DELETING UNNECESSARY FEATURES
  • DOCUMENTATION & DEVOPS
  • Etc..

Test Environment

local, M1 Mac, Windows 11

Major Changes

  • remove coverage test & template inspection hooks at pre-commit
    • pre-commit now checks source linting, formatting independently of the system(SYSTEM_PATH config).
    • coverage test will triggered automatically when making PR
    • template inspection also triggered automatically by Github Actions when making PR of adding new template or editing existing template at fastapi_project_template
  • update development guides: CONTRIBUTING.md, docs/en materials

Screenshots (optional)

N/A

Etc

close #38

@bnbong bnbong self-assigned this Jan 24, 2026
@github-actions github-actions bot added the template Add or editing a FastAPI template label Jan 24, 2026
@bnbong bnbong added documentation Improvements or additions to documentation fix Fix or improve source codes and removed template Add or editing a FastAPI template labels Jan 24, 2026
@bnbong bnbong requested a review from Copilot January 24, 2026 11:16
@codecov
Copy link

codecov bot commented Jan 24, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

Copy link
Contributor

Copilot AI left a 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.yaml to run Black/Isort/Mypy via language: python hook envs (no more language: system scripts).
  • 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>
@github-actions github-actions bot added the template Add or editing a FastAPI template label Jan 24, 2026
@bnbong bnbong removed the template Add or editing a FastAPI template label Jan 24, 2026
@bnbong bnbong merged commit 82b59dd into main Jan 24, 2026
14 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation fix Fix or improve source codes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[BUGS] pre-commit is dependent on a specific environment

2 participants