Git Workflow Conventions

Quick Start

Commit Format

All commits follow Conventional Commits:

<type>(<scope>): <description>

[optional body]

[optional footer]

Types: feat, fix, docs, style, refactor, perf, test, chore, build, ci

Scopes: Define project-specific scopes in project-context.mdc. Common examples: api, ui, db, auth, build, cursor

Agentic workflow commits: Use chore(cursor): for commands/rules/plans, docs(cursor): for reference docs.

Branch Naming

<firstname>/<issue-id>-<short-slug>

• •First name only (e.g., ryan not ryankilroy)
• •Slug under 30 chars, action verb + key noun
• •Example: ryan/{prefix}-149-add-agentic-context

PR Review Prefixes

Use "we"/"the code" instead of "you" in review comments.

Issue Tracker Integration

Configure your issue tracker in project-context.mdc:

• •Branch names include issue ID: username/{prefix}-xxx-description
• •Magic words auto-close on merge: Closes {PREFIX}-XXX, Fixes {PREFIX}-XXX, Resolves {PREFIX}-XXX
• •Link without closing: Refs {PREFIX}-XXX

Examples:

• •Linear: ryan/n43-123-add-auth, Closes N43-123
• •Jira: ryan/proj-456-fix-bug, Closes PROJ-456
• •GitHub: ryan/789-update-docs, Closes #789

PR Workflow

1. •Squash commits into logical chunks
2. •Rebase onto main (never merge)
3. •Use --force-with-lease when pushing after rebase

Additional Resources

• •For complete documentation, see reference.md