Git Best Practices

Git Best Practices

Always Active Principles

When this skill is loaded, follow these directives for all git operations:

1. Discover before acting — run branch discovery to determine the repo's default and production branches before branching, merging, or opening PRs
2. Conventional commits — every commit uses type(scope): description format
3. Stage explicitly — add files by name so only intended changes are committed
4. Protect shared history — use --force-with-lease for force pushes; confirm with the user before any force push

Agent Git Workflow

1. Check state — run git status and git diff HEAD
2. Discover branches — identify default/current/(optional) production branch names (see Branch Discovery)
3. Stage by name — git add path/to/file for each file; verify with git status
4. Write a conventional commit — type(scope): description with optional body
5. Push safely — regular push by default; git push --force-with-lease origin {branch} only for rewritten history after user confirmation

Checkpoint Commits

Agents may create WIP checkpoint commits during long-running tasks, cleaned up before PR.

• Prefix with wip: or use standard conventional commit format
• Keep changes logically grouped even in WIP state
• Run /rewrite-history before opening a PR to craft a clean narrative

Commit Discipline

• Stage files explicitly by name: git add src/auth.ts src/auth.test.ts
• Verify staged content with git status before committing
• Keep secrets, .env files, credentials, and large binaries out of commits — warn the user if staged files look sensitive
• Target one logical change per commit in final PR-ready state

Force Push

Use --force-with-lease exclusively to protect against overwriting upstream changes:

git push --force-with-lease origin feat/my-branch

Always confirm with the user before any force push, regardless of branch.

Conventional Commits

Format: type(scope): description

Subject line rules:

• Lowercase, imperative mood, no trailing period
• Under 72 characters
• Scope is optional but preferred when a clear subsystem exists

Common types:

Commit Bodies

Body is optional — only add one when the change is genuinely non-obvious. The subject line carries the "what"; the body explains "why."

Add a body when:

• The motivation or tradeoff is non-obvious
• Multi-part changes benefit from a bullet list
• External context is needed (links, issue references, root cause)

See git-examples.md for commit message examples.

Branch Discovery

Before branching or opening a PR, discover the repo's branch topology. Run these commands and store the results:

# Default branch (PR target for most repos)
gh repo view --json defaultBranchRef --jq '.defaultBranchRef.name'

# Current branch
git branch --show-current

# Production branch (if different from default)
git branch -r --list 'origin/main' 'origin/master' 'origin/production'

If gh is unavailable or the repo has no remote, see the fallback commands in git-examples.md.

Store the discovered branch name and reference it throughout. Use the actual branch name in all subsequent commands.

Branch Naming

Use repository branch naming conventions first. If no convention is documented, use:

Format: type/description-TICKET-ID

Examples:

• feat/add-login-SEND-77
• fix/pool-party-stall-SEN-68
• chore/update-deps
• hotfix/auth-bypass

Include the ticket ID when an issue exists. Omit when there is no ticket.

Branch Flow

Use repository branch flow policy first. If policy is undocumented, a common baseline is:

{production-branch} (production deploys)
 └── {default-branch} (staging/testnet deploys, PR target)
      ├── feat/add-feature-TICKET
      ├── fix/bug-description-TICKET
      └── hotfix/* (branches off production branch for hotfixes)

• Feature and fix branches start from the default branch
• Hotfix branches start from the production branch
• PRs target the default branch unless the repo uses a single-branch flow
• When default branch and production branch are the same, all PRs target that branch directly

Merge Strategy

Use repository merge policy first (required in many organizations).

If no policy exists, these defaults are reasonable:

PR Workflow

Sizing

Pragmatic sizing over arbitrary limits. Each commit tells a clear story regardless of PR size. A PR should be reviewable as a coherent unit — if a reviewer cannot hold the full change in their head, consider splitting.

PR Creation

Use repo-native PR tooling (gh pr create, GitLab CLI, or web UI) with:

• Short title under 70 characters
• Summary section with 1-3 bullet points
• Test plan as a bulleted checklist

History Rewriting Before PR

For branches with messy WIP history, use /rewrite-history to:

1. Backup the branch
2. Reset to the base branch tip
3. Recommit changes as a clean narrative sequence
4. Verify byte-for-byte match with backup
5. Confirm with the user before force-pushing rewritten history
6. Open PR with link to backup branch

Each rewritten commit introduces one coherent idea, building on the previous — like a tutorial teaching the reader how the feature was built.

Converted and distributed by TomeVault — claim your Tome and manage your conversions.