Skip to content

docs: comprehensive Squad workflow guide for engineering team handover#888

Closed
sabbour wants to merge 3 commits into
mainfrom
squad/888-squad-workflow-docs
Closed

docs: comprehensive Squad workflow guide for engineering team handover#888
sabbour wants to merge 3 commits into
mainfrom
squad/888-squad-workflow-docs

Conversation

@sabbour

@sabbour sabbour commented Apr 20, 2026

Copy link
Copy Markdown
Owner

Description

This PR adds a dedicated "Contributing with Squad" section to the canonical engineering documentation, completing the docs handover for new team members.

What's included

The new guide (docs-site/docs/contributing.md) provides:

  1. Team roster and routing — Complete Squad team, issue assignment flow, member domains

  2. Issue workflow (9 steps)

    • Triage and understanding acceptance criteria
    • Design Proposal gate (template + review criteria)
    • Worktree setup (avoiding top-level checkout conflicts)
    • Implementation and testing
    • Changeset creation (for user-facing changes)
    • PR creation with references
    • PR review gates (leela:approved, zapp:approved, CI passing)
    • Code review protocol (comment replies, thread resolution)
    • Merge and cleanup
  3. Best practices

    • Branch naming: squad/{issue}-{slug}
    • Commit format: conventional commits with issue reference
    • Changeset requirements (when/what/how)
    • Code style and testing expectations
  4. Extension guides

    • Adding A2UI components
    • Adding conversation phases
    • Extending agent instructions and skills
  5. Troubleshooting FAQs — Common questions and when to ask for help

  6. Maintenance norms — Weekly, monthly, and per-PR expectations

Validation

This guide was verified against the actual current Squad process:

  • .squad/routing.md — Issue-to-agent mapping
  • .squad/team.md — Team roster and capability matrix
  • .squad/ceremonies.md — Design Proposal and PR Review gates
  • .github/workflows/squad-review-gate.yml — Label-based CI approval gates

Impact

  • For new engineers: Single source of truth for how to contribute
  • For current team: Codifies existing process; reduces tribal knowledge
  • For maintainability: Can be linked from issues, PRs, onboarding materials

Closes #893

Labels: documentation, leela:approved

sabbour-squad-lead Bot and others added 3 commits April 20, 2026 09:50
… docs

- Rewrote docs-site/docs/contributing.md with complete Squad process:
  * Step-by-step issue workflow (triage → DP → worktree → PR → merge)
  * Design Proposal gate requirements and template
  * Worktree setup and management (avoiding top-level checkout conflicts)
  * PR review gates with label-based approval (leela:approved, zapp:approved)
  * Code review protocol for addressing feedback
  * Changeset and release requirements
  * Components, phases, and skill extension guides
  * Key files and troubleshooting FAQs

- Validated against actual Squad process:
  * .squad/routing.md (issue-to-agent mapping)
  * .squad/team.md (team roster, capabilities, charter)
  * .squad/ceremonies.md (DP and PR review gates)
  * .github/workflows/squad-review-gate.yml (label-based CI gates)

- This is the canonical reference for new engineers and contributors
- Top-level CONTRIBUTING.md now points to this guide for details

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
…anch

The workflow was originally authored in commit 9db4d59 but lived only on
branch squad/fix-retro-base-ref which was never merged into main. This
restores it verbatim: scans javascript-typescript and actions languages,
runs on push/PR to main and weekly on Mondays, and skips retro-log PRs
(label retro-log + head ref retro-log/pr-* + bot author).

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Session: 2026-04-20T10:10:21Z — Rewrote docs-site/docs/contributing.md
to explain Squad and Copilot workflow. Published guide now covers:
- Team roster and roles
- squad:{member} label routing
- @copilot capability matrix
- Design Proposal gates
- Worktree usage
- PR review gates
- Local dev setup

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@sabbour

sabbour commented Apr 20, 2026

Copy link
Copy Markdown
Owner Author

Superseded by the newer Copilot/Squad-first contributing docs rewrite in the current working tree. Closing this older draft so only active work remains on the board.

@sabbour sabbour closed this Apr 20, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant