git-workflow

Git Workflow

Standard Git workflow for all tasks in this repository.

⚠️ MANDATORY: Check Branch Before Starting ANY Task

This is the FIRST step for ANY task that involves code changes.

Before writing any code or making any changes, you MUST check the current branch:

git branch --show-current

Decision Flow

Current Branch?
    │
    ├─ main → ❌ DO NOT work here
    │         → Create a new branch first (see "Creating a New Branch")
    │
    ├─ Feature branch for this task → ✅ Continue working
    │
    └─ Different feature branch → ⚠️ Ask user which branch to use

If on main Branch

NEVER make changes directly on main. Always create a new branch first:

# 1. Ensure main is up to date
git fetch origin
git reset --hard origin/main

# 2. Create new branch
git checkout -b {type}/{brief-description}-{issue-number}

If on Wrong Feature Branch

Ask the user:

"You are currently on branch {current-branch}. Should I:

1. Continue working on this branch?
2. Switch to main and create a new branch for this task?"

Example Check Output

$ git branch --show-current
main
# → Must create new branch before any work!

$ git branch --show-current
feature/add-taproot-support-123
# → OK to continue if this is the correct branch for the task

---

Branch Management

Creating a New Branch

Always create from latest main:

git fetch origin
git checkout main
git reset --hard origin/main
git checkout -b {type}/{brief-description}-{issue-number}

Branch Naming Convention

Format: {type}/{brief-description}-{issue-number}

• Description should be short and meaningful (use kebab-case)
• Issue number at the end (just the number, no "issue-" prefix)

Type	Prefix	Example
Feature	feature/	feature/add-taproot-support-123
Bug fix	fix/	fix/db-connection-error-456
Refactoring	refactor/	refactor/clean-arch-layer-789
Documentation	docs/	docs/update-readme-311
DevOps/CI	ci/	ci/add-lint-workflow-100
Chore	chore/	chore/update-deps-200