mahabdalla Saleor Commit
Workflow
- Activate virtual env:
source .venv/bin/activate(look for.venvdir in project root) - Run
git statusandgit diff(staged + unstaged) to understand all changes - Stage relevant files with
git add(specific files, notgit add -A) - Write a comprehensive commit message describing what changed and why
- Run
git commit - If pre-commit hooks fail, follow error resolution below and retry
Commit Message Format
Use a HEREDOC for the message:
git commit -m "$(cat <<'EOF'
Short summary of changes
Detailed description of what was changed and why.
List specific modifications when multiple files are affected.
EOF
)"
Pre-commit Hook Error Resolution
The project runs these hooks: trailing-whitespace, end-of-file-fixer, ruff (lint + format), mypy, deptry, semgrep, uv-lock, migrations-check, gql-schema-check.
Ruff errors (lint/format)
Ruff auto-fixes and auto-formats on commit. After a failure:
- Stage the auto-formatted files:
git add <files> - Retry the commit
- If it fails again, read the error output — some issues require manual fixes (unused imports, type annotations, etc.)
Mypy errors
Read the error output carefully. Fix the typing issues in the reported files. Stage and retry.
Outdated GraphQL schema (gql-schema-check)
Regenerate the schema and stage it:
python manage.py get_graphql_schema > saleor/graphql/schema.graphql
git add saleor/graphql/schema.graphql
Missing migrations (migrations-check)
Create the missing migration:
python manage.py makemigrations
git add saleor/**/migrations/*.py
Other hooks
- trailing-whitespace / end-of-file-fixer: Auto-fix applied. Stage changed files and retry.
- deptry: Fix dependency issues in pyproject.toml.
- semgrep: Read the finding, fix the flagged code pattern.
- uv-lock: Stage the updated
uv.lockfile.
Converted and distributed by TomeVault | Claim this content