Git Workflow Skill Plannededge Codebook

Git Workflow Skill

[!FIXED!]

Purpose

This skill provides procedures for Git operations in the development workflow. It covers branching, commits, and pull requests.

When to use:

• Creating branches for new work
• Making commits
• Creating pull requests
• Merging changes [!FIXED!]

=== PREREQUISITES ===

Before using this skill:

• Git is installed
• Repository is cloned locally
• Commit message standard exists (@ref(CB-STD-COMMITS-001))
• You have push access (or will create PR)

=== PROCEDURE: CREATE BRANCH ===

Branch Naming Convention

<type>/<description>

Types:
- feature/  : New features
- bugfix/   : Bug fixes
- hotfix/   : Urgent production fixes
- refactor/ : Code refactoring
- docs/     : Documentation only
- test/     : Test additions
- chore/    : Maintenance tasks

Steps

1. Ensure you're on main/develop

   git checkout main
   git pull origin main
   

2. Create and checkout new branch

   git checkout -b feature/add-user-authentication
   

3. Log in buildlog

   | HH:MM | #micro-decision | Created branch feature/add-user-authentication | - |
   

Branch Naming Examples

=== PROCEDURE: MAKE COMMITS ===

Commit Message Format

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

[optional body]

[optional footer]

Types

Steps

1. Stage changes

   git add <files>
   # or for all changes:
   git add .
   

2. Review staged changes

   git status
   git diff --staged
   

3. Commit with message

   git commit -m "feat(auth): add OAuth2 login support"
   

4. Log in buildlog

   | HH:MM | #commit | feat(auth): add OAuth2 login support | PR #XX |
   

Commit Message Examples

Commit Frequency

• Commit logical chunks of work
• Each commit should be independently functional
• Don't bundle unrelated changes
• Can be squashed later if needed

=== PROCEDURE: CREATE PULL REQUEST ===

Before Creating PR

1. Ensure all commits are pushed

   git push origin <branch-name>
   

2. Run pre-merge checks

   • All tests pass
   • Linter passes
   • Code reviewed by self
   • Documentation updated if needed

PR Title Format

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

Same format as commit messages.

PR Description Template

## Summary
Brief description of what this PR does.

## Changes
- List of significant changes
- Bullet points preferred

## Testing
- How was this tested?
- Test coverage info

## Related Issues
Closes #123
Related to #456

## Checklist
- [ ] Tests pass
- [ ] Documentation updated
- [ ] No breaking changes (or documented)

Steps

1. Push branch

   git push -u origin feature/add-user-authentication
   

2. Create PR via GitHub/GitLab/etc.

   • Use PR title format
   • Fill in description template
   • Add reviewers
   • Add labels

3. Log in buildlog

   | HH:MM | #micro-decision | Created PR #42 for feature/add-user-authentication | PR #42 |
   

=== PROCEDURE: MERGE CHANGES ===

Merge Strategies

Steps

1. Ensure PR is approved

   • Required reviews complete
   • CI checks pass
   • No merge conflicts

2. Merge using preferred strategy

   • Via GitHub UI, or:

   git checkout main
   git merge --squash feature/add-user-authentication
   git commit -m "feat(auth): add OAuth2 login support (#42)"
   git push origin main
   

3. Delete branch

   git branch -d feature/add-user-authentication
   git push origin --delete feature/add-user-authentication
   

4. Log in buildlog

   | HH:MM | #commit | Merged feat(auth): add OAuth2 login support | PR #42 |
   

=== PROCEDURE: HANDLE CONFLICTS ===

Steps

1. Update main and rebase

   git checkout main
   git pull origin main
   git checkout feature/your-branch
   git rebase main
   

2. Resolve conflicts

   • Open conflicting files
   • Resolve conflict markers
   • Test resolution

   git add <resolved-files>
   git rebase --continue
   

3. Force push (if rebased)

   git push --force-with-lease origin feature/your-branch
   

4. Log in buildlog

   | HH:MM | #resolution | Resolved merge conflicts in <files> | PR #42 |
   

Conflict Prevention

• Rebase frequently against main
• Communicate about files being modified
• Break large changes into smaller PRs

=== PROCEDURE: REVERT CHANGES ===

Revert a Commit

# Revert last commit (creates new commit)
git revert HEAD

# Revert specific commit
git revert <commit-hash>

# Revert without auto-commit
git revert -n <commit-hash>

Log in Buildlog

| HH:MM | #resolution | Reverted commit <hash> due to <reason> | - |

=== ANTI-PATTERNS ===

=== RELATED DOCUMENTS ===