Skip to content

Latest commit

 

History

History
111 lines (88 loc) · 2.47 KB

File metadata and controls

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

GitHub workflow assistant for StackMemory project.

Branch Naming

Format: {type}/{description} or {type}-{linear-id}/{description}

Examples:

  • feat/railway-storage
  • fix/context-bridge-hanging
  • sta-98/storage-tiers
  • refactor/frame-manager

Commit Messages

Use Conventional Commits format with Linear ticket references:

<type>[optional scope]: <description> [optional ticket]

[optional body]

Types

  • feat: New feature
  • fix: Bug fix
  • docs: Documentation only
  • refactor: Code restructuring
  • test: Test additions/updates
  • perf: Performance improvements
  • chore: Maintenance tasks

Examples

feat(storage): implement 3-tier Railway storage system (STA-98)
fix(cli): resolve context commands hanging issue
docs(api): add comprehensive MCP tool documentation
refactor(frame): add skipContextBridge option for CLI ops
test(integration): add Phase 3 integration test suite
perf(context): optimize frame retrieval to <100ms

Creating a Commit

  1. Check status and diff:

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

    git add -p  # Interactive staging
  3. Create commit with proper format:

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

Creating a Pull Request

  1. Push branch:

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

    gh pr create --title "type(scope): description (STA-XX)" --body "$(cat <<'EOF'
    ## Summary
    - What changed and why
    - Linear ticket: STA-XX
    
    ## Changes
    - Specific file/module changes
    - New features/fixes implemented
    - Breaking changes (if any)
    
    ## Test Plan
    - [ ] Unit tests pass
    - [ ] Integration tests pass
    - [ ] Manual testing completed
    - [ ] Performance benchmarks run
    
    ## Performance Impact
    - Operations: ~XXXms
    - Memory: XXX KB
    
    ## Documentation
    - [ ] API docs updated
    - [ ] README updated if needed
    EOF
    )"

StackMemory-Specific Checks

Before creating PR:

  • ESM imports use .js extension
  • Context bridge handled properly in CLI
  • Frame lifecycle managed correctly
  • Tests added for new features
  • Linear ticket referenced
  • Performance measured
  • No TypeScript any types