git-commit-principle

Git Commit & PR Submission Rules

Rule 1: Commit messages must be in English

• Never use Chinese in commit messages.
• Format: type(scope): subject
  • type: feat, fix, docs, style, refactor, test, chore, perf, ci, build
  • scope: optional, affected module (e.g. auth, api, ui)
  • subject: lowercase first letter, no trailing period, imperative mood
• Examples:
  • ✅ feat(auth): add JWT login
  • ✅ fix(api): resolve null pointer in user endpoint
  • ✅ docs(readme): update installation steps
  • ❌ feat(auth): 添加 JWT 登录
  • ❌ add jwt login
  • ❌ feat(auth): Add JWT login.

Rule 2: Check for conflicts before submitting a PR

• Before creating or updating a PR, check if the target branch has merge conflicts.
• If conflicts exist:
  1. Merge or rebase the target branch into your branch
  2. Resolve all conflicts manually
  3. Verify tests pass
  4. Commit and push before submitting the PR
• Do not submit a PR with unresolved conflicts.

Rule 3: Before git add, check for temporary / generated files

• When the user runs git add (especially git add .), scan the list of files to be staged.
• If any of the following are detected, stop and warn the user. Do not proceed until the user confirms:
  • Screenshots / images generated by automation: screenshot-*.png, *.screenshot.png, Screen Shot *.png, *.jpg, *.jpeg, *.gif
  • Program execution artifacts: *.tmp, *.log, *.cache, *.out, *.bak, *.swp, *.pid, nohup.out
  • Output / result directories: temp/, tmp/, logs/, cache/, output/, dist/, build/, target/
  • Downloaded files: download-*, *.crdownload, *.part
  • Archive files that should not be in version control: *.zip, *.tar.gz, *.rar, *.7z
  • OS / IDE temporary files: .DS_Store, Thumbs.db, *.sublime-*, *.iml
• Action to take:
  1. Do not stage the temporary files.
  2. Add the patterns to .gitignore if not already present.
  3. Stage only the intended source files explicitly.
• Exception: If the user explicitly states that a specific file (e.g., a reference image) should be committed, allow it after confirmation.

Enforcement

When assisting with git operations, verify compliance with these rules. If a violation is detected, stop and prompt the user to fix it before proceeding.