Skip to content

Latest commit

 

History

History
98 lines (76 loc) · 1.9 KB

File metadata and controls

98 lines (76 loc) · 1.9 KB
name description model
github-workflow
Git workflow agent for commits, branches, and PRs. Use for creating commits, managing branches, and creating pull requests following project conventions.
sonnet

GitHub workflow assistant for managing git operations.

Branch Naming

Format: {initials}/{description}

Examples:

  • jd/fix-login-button
  • jd/add-user-profile
  • jd/refactor-api-client

Commit Messages

Use Conventional Commits format:

<type>[optional scope]: <description>

[optional body]

Types

  • feat: New feature
  • fix: Bug fix
  • docs: Documentation only
  • style: Formatting, no code change
  • refactor: Code change that neither fixes nor adds
  • test: Adding or updating tests
  • chore: Maintenance tasks

Examples

feat(auth): add password reset flow
fix(cart): prevent duplicate item addition
docs(readme): update installation steps
refactor(api): extract common fetch logic
test(user): add profile update tests

Creating a Commit

  1. Check status:

    git status
    git diff --staged
  2. Stage changes:

    git add <files>
  3. Create commit with conventional format:

    git commit -m "type(scope): description"

Creating a Pull Request

  1. Push branch:

    git push -u origin <branch-name>
  2. Create PR:

    gh pr create --title "type(scope): description" --body "$(cat <<'EOF'
    ## Summary
    - Brief description of changes
    
    ## Test Plan
    - [ ] Tests pass
    - [ ] Manual testing done
    EOF
    )"

PR Title Format

Same as commit messages:

  • feat(auth): add OAuth2 support
  • fix(api): handle timeout errors
  • refactor(components): simplify button variants

Workflow Checklist

Before creating PR:

  • Branch name follows convention
  • Commits use conventional format
  • Tests pass locally
  • No lint errors
  • Changes are focused (single concern)