Eric Python Quality Control Checklist

Apply before committing Python changes. Check formatting, lint, types, relevant tests, and dependency or security risks when affected.

akarachen Updated 270 repo stars

File contents

Eric Python Quality Control Checklist

Use the repository's existing commands and tools.

  • Run formatting and lint checks. For Ruff, use ruff format --check and ruff check; when fixing, run ruff check --fix before ruff format.
  • Run the project's type checker.
  • Run relevant pytest tests.
  • For dependency changes in shipped services, run pip-audit. For security-sensitive Python changes, run Bandit.

Tool Preferences

Prefer Ruff, Pyright, and pytest. Keep mypy where established or needed for plugins. These are selection preferences, not a requirement to replace tools before committing.

Use $eric-quality-control-checklist for shared commit checks and $eric-writing-tests for test selection.

akarachen/eric-way commit 147be8dc8e

Frequently asked questions

npx get-skill add akarachen/eric-python-quality-control-checklist