samples: standardize READMEs, naming, and add template#484
Merged
bradygaster merged 2 commits intobradygaster:devfrom Mar 22, 2026
Merged
samples: standardize READMEs, naming, and add template#484bradygaster merged 2 commits intobradygaster:devfrom
bradygaster merged 2 commits intobradygaster:devfrom
Conversation
Collaborator
Author
|
@bradygaster — team reviewed and signed off on this one (Mal, Book, Simon, River all approved). Covers PRD recs #3 (package naming), #8 (README standardization), and #9 (root README overhaul). No code logic changes — pure docs/naming improvements. All markdownlint and cspell checks pass. Ready for your review when you get a chance. |
Add 31 tests defining the behavioral contract for the planned autonomous-pipeline-core module (PRD Recommendation #1). Tests cover: - Task→tier assignment via selectResponseTier with DEMO_CONFIG - CostTracker per-agent accumulation across multiple agents/tasks - Agent state transitions (idle→working→idle→done lifecycle) - selectResponseTier routing properties (tier, modelTier, maxAgents, timeout) - Task queue creation, role coverage, and findNextTask assignment logic - simulateCost model contract (complexity→tokens→cost scaling) - Core pipeline wiring without telemetry/dashboard/OTel dependencies All 31 tests pass against current code. After the refactor splits core logic from telemetry+dashboard, these same assertions verify the extracted module preserves identical behavior. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
- Standardize all 9 package.json names to @squad-samples/* format (Rec #3) - Rewrite root samples/README.md as public-facing index with learning path (Rec #9) - Standardize all 9 per-sample READMEs to consistent template (Rec #8) - Apply Microsoft Writing Style Guide across all sample documentation - Add SAMPLE-README-TEMPLATE.md for future sample authors - Add 31 TDD tests for autonomous-pipeline core split (Rec #1 prep) 17 files modified, 1 new file. All markdownlint and cspell checks pass. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
bradygaster
force-pushed
the
squad/examples-improvements
branch
from
5285bcd to
3f6f074
Compare
bradygaster
approved these changes
Mar 22, 2026
Owner
bradygaster
left a comment
bradygaster
left a comment
There was a problem hiding this comment.
PAO review: Sample standardization looks clean. Consistent READMEs and naming. Rebased on dev.
chrislomonico
pushed a commit
to clomonico/squad
that referenced
this pull request
Mar 26, 2026
… (bradygaster#484) * test: human journey — Power user (bradygaster#396) Add E2E journey test covering advanced shell features: - /help and /status slash commands - Tab completion for /commands and @agent names - Ctrl+C cancel during processing - Double Ctrl+C exit - Multiple slash commands in sequence - @agent direct routing with complex messages Closes bradygaster#396 Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * test: human journey — I'm waiting and getting anxious (bradygaster#385) Add E2E journey test covering the user experience while waiting for agent responses: thinking indicators, phase labels, activity hints, streaming content updates, /status visibility, Ctrl+C cancellation, and recovery after cancel. 14 test cases validate the full anxiety-to-reassurance path. Closes bradygaster#385 Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --------- Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
SDK Samples Portfolio Improvements (PRD Recs #3, #8, #9)
Hey @bradygaster — the team reviewed and approved this set of improvements to the samples portfolio. This PR focuses on documentation and naming consistency — no code logic changes, just making the samples more accessible to new users.
What changed
18 files changed (17 modified, 1 new) — all in
samples/Recommendation #3: Package naming standardization
package.jsonfiles now use@squad-samples/{name}format-samplesuffix,@squad-samples/scope)@squad-samples/*across the boardRecommendation #9: Root samples/README.md overhaul
Recommendation #8: Per-sample README standardization
New: SAMPLE-README-TEMPLATE.md
Why this matters
The samples are Squad's primary on-ramp for new developers. Today:
After this PR:
CI status
markdownlint— 0 errors (134 files checked)cspell— 0 issues on all changed filesTeam review
PRD reference
Full PRD with 9 active recommendations (this PR covers #3, #8, #9) is tracked in our project management repo. Remaining recommendations (#1 pipeline split, #2 LLM test coverage, #5 demo/live separation, #10 docs site integration) planned for follow-up PRs.