Skip to content

Commit a78fd7d

Browse files
bradygasterCopilot
andauthored
docs: add Squad Contributors Guide page (#276) (#277)
* docs(ai-team): Session log for McManus contributing guide Session: 2026-03-08T16-18-00Z-contributing-guide Spawned by: user Changes: - Logged McManus orchestration session (contributing guide #274) - Created session log entry with deliverables and verification - Staged team memory updates (mcmanus history.md) * docs: add Squad Contributors Guide page to docs site (#276) Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --------- Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
1 parent c5e4f1b commit a78fd7d

4 files changed

Lines changed: 250 additions & 1 deletion

File tree

‎.squad/agents/mcmanus/history.md‎

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,30 @@
3636

3737
## Learnings
3838

39+
### 2026-03-16: Squad Contributors Guide — Docs Page (#276)
40+
41+
**Status:** Complete. Created dedicated contributors guide page in docs site Guide section.
42+
43+
**Summary:**
44+
Created `docs/guide/contributors.md` to honor every community contributor to Squad. Issue #276 requested a proper docs page thanking everyone who has contributed, whether through merged PRs or impactful issues/discussions. The page lists all contributors in reverse-chronological order (most recent first) to keep it current and acknowledge recent work prominently.
45+
46+
**Implementation:**
47+
- Created comprehensive contributors guide with two sections:
48+
- **Code Contributors** (11 people): merged PRs from @tamirdresher (4 PRs), @williamhallatt (5 PRs), @EmmittJ, @jsturtevant, @aadnesd, @CarlosSardo, @codebytes, @spboyer, @digitaldrummerj, @danielscholl, @csharpfritz
49+
- **Community Contributors** (25+ people): issues/discussions that drove improvements, including @lbouriez (credential leak → secret guardrails), @eric-vanartsdalen (docs 403), @LasseAtSparkron (ESM crash), @swnger (skill-based orchestration → defineSkill()), and many more
50+
- Updated `docs/build.js` to add 'contributors' to the guide section order, right after 'contributing'
51+
- Built docs successfully — new page renders at `/guide/contributors`
52+
- Opened PR #277 targeting main
53+
54+
**Tone & Structure:**
55+
- Warm, appreciative opening: "This page honors everyone who has submitted code, filed issues, started discussions, and shared ideas that have shaped this project."
56+
- Each contributor section shows their GitHub handle (linked), real name when known, most recent contribution date, then bullet list of all contributions with issue/PR links
57+
- Closing note: "This page is updated with every release. No contribution goes unappreciated."
58+
- Zero hype, all substance — every line is factual and cited
59+
60+
**DevRel Pattern Reinforced:**
61+
Recognition is a cornerstone of community health. Brady tracks every contributor meticulously, and now we have a permanent, public home for that gratitude. This page serves both as thanks and as social proof—new contributors can see that their work will be acknowledged. The reverse-chronological ordering keeps it fresh and relevant with each release.
62+
3963
### 2026-03-13: Community Discussions — Terminal Flickering & Skill-Based Orchestration
4064

4165
**Status:** Complete. Posted warm replies to Discussions #170 (terminal flickering) and #169 (skill-based orchestration).
@@ -1439,3 +1463,40 @@ Multi-agent build of Rock-Paper-Scissors game with 10 AI strategies, Docker infr
14391463

14401464

14411465

1466+
1467+
## Learnings
1468+
1469+
### Docs Build System — Issue #274
1470+
1471+
**Pattern: Adding new pages to the docs site**
1472+
1473+
The docs site uses docs/build.js to discover and render markdown files:
1474+
1475+
1. **Create the markdown file** in the appropriate section directory (e.g., docs/guide/contributing.md)
1476+
- Add a clear H1 heading — this becomes the page title
1477+
- Use relative links that will work after the .md → .html conversion
1478+
- The build.js rewriteLinks function handles .md → .html automatically
1479+
1480+
2. **Add to SECTION_ORDER** in build.js (line 44–60)
1481+
- SECTION_ORDER.guide, SECTION_ORDER['get-started'], etc.
1482+
- Order matters — items appear in the nav in the order listed
1483+
- If not in the explicit order list, pages fall back to alphabetical
1484+
1485+
3. **Fix broken relative links** in other docs
1486+
- ../CONTRIBUTING.md doesn't work on the published site (GitHub Pages doesn't serve the repo root)
1487+
- Use ./guide/contributing.html instead (relative to the docs root)
1488+
1489+
4. **Verify the build** —
1490+
ode docs/build.js outputs to docs/dist/
1491+
- Check the console for "✓ Generated guide/contributing.html"
1492+
- Total page count increments
1493+
1494+
**Key file paths:**
1495+
- docs/build.js — build script with SECTION_ORDER config (line 44–60)
1496+
- docs/template.html — HTML template with nav injection
1497+
- docs/dist/ — generated site (not committed, GitHub Pages builds from docs/ markdown on deploy)
1498+
1499+
**Adapting content for the docs site:**
1500+
- Keep substance, add proper H1, lightly restructure for web readability
1501+
- Don't just copy verbatim — the docs site is a curated experience
1502+
- Tone ceiling applies: factual, no hype, citations for claims

‎.squad/decisions.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10781,3 +10781,9 @@ Added: "First-day mistakes on main are not acceptable. Process discipline starts
1078110781
1078210782
1078310783
### 2026-03-08T13:28Z: User directive **By:** Brady (via Copilot) **What:** Users should NEVER have to worry about secrets being leaked by Squad agents. This is non-negotiable. Also, minimize GitHub Actions usage for security scanning — prefer local/runtime guards over CI-based scanning. **Why:** User request — captured for team memory. Actions minutes are already heavily used; prefer SDK-level enforcement that costs zero CI time.
10784+
10785+
10786+
### 2026-03-08T16:24Z: User directive — Contributors page updated every release
10787+
**By:** Brady (via Copilot)
10788+
**What:** Every release must include an update to the Squad Contributors Guide page in the docs site. No contribution goes unappreciated — all issues, discussions, and PRs that led to shipped work must be acknowledged.
10789+
**Why:** User request — captured for team memory and release checklist.

‎docs/build.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ const SECTIONS = [
4646
// Explicit ordering within sections (filename without .md → priority)
4747
const SECTION_ORDER = {
4848
'get-started': ['installation', 'first-session', 'migration'],
49-
'guide': ['tips-and-tricks', 'sample-prompts', 'personal-squad', 'contributing'],
49+
'guide': ['tips-and-tricks', 'sample-prompts', 'personal-squad', 'contributing', 'contributors'],
5050
'features': [
5151
'team-setup', 'routing', 'model-selection', 'response-modes',
5252
'parallel-execution', 'memory', 'skills', 'directives',

‎docs/guide/contributors.md‎

Lines changed: 182 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,182 @@
1+
# Squad Contributors Guide
2+
3+
Thank you to every contributor who has helped make Squad better. This page honors everyone who has submitted code, filed issues, started discussions, and shared ideas that have shaped this project. This page is updated with every release.
4+
5+
## Code Contributors
6+
7+
These community members submitted merged pull requests to Squad:
8+
9+
### [@tamirdresher](https://github.com/tamirdresher) (Tamir Dresher)
10+
Most recent: March 8, 2026
11+
12+
- [#272](https://github.com/bradygaster/squad/pull/272) — Renamed workstreams to SubSquads
13+
- [#263](https://github.com/bradygaster/squad/pull/263) — Added CommunicationAdapter
14+
- [#191](https://github.com/bradygaster/squad/pull/191) — Implemented Azure DevOps adapter
15+
- [#225](https://github.com/bradygaster/squad/pull/225) — Wired upstream command
16+
17+
### [@EmmittJ](https://github.com/EmmittJ) (Emmitt)
18+
Most recent: March 7, 2026
19+
20+
- [#230](https://github.com/bradygaster/squad/pull/230) — Wired squad link + init --remote
21+
22+
### [@williamhallatt](https://github.com/williamhallatt) (William Hallatt)
23+
Most recent: March 7, 2026
24+
25+
- [#219](https://github.com/bradygaster/squad/pull/219) — Added fork contribution docs
26+
- [#217](https://github.com/bradygaster/squad/pull/217) — Fixed init follow-up issue
27+
- [#221](https://github.com/bradygaster/squad/pull/221) — Restored CI green status
28+
- [#203](https://github.com/bradygaster/squad/pull/203) — Fixed init workflow
29+
- [#185](https://github.com/bradygaster/squad/pull/185) — Fixed template path issue
30+
31+
### [@jsturtevant](https://github.com/jsturtevant) (James Sturtevant)
32+
Most recent: March 5, 2026
33+
34+
- [#198](https://github.com/bradygaster/squad/pull/198) — Added consult mode CLI
35+
36+
### [@aadnesd](https://github.com/aadnesd)
37+
Most recent: March 5, 2026
38+
39+
- [#204](https://github.com/bradygaster/squad/pull/204) — Fixed OpenTelemetry dependency issue
40+
41+
### [@CarlosSardo](https://github.com/CarlosSardo) (Carlos Sardo)
42+
Most recent: March 4, 2026
43+
44+
- [#178](https://github.com/bradygaster/squad/pull/178) — Added GitLab Issues walkthrough
45+
46+
### [@codebytes](https://github.com/codebytes) (Chris Ayers)
47+
Most recent: February 20, 2026
48+
49+
- [#97](https://github.com/bradygaster/squad/pull/97) — Created Star Trek casting universe
50+
51+
### [@spboyer](https://github.com/spboyer) (Shayne Boyer)
52+
Most recent: February 20, 2026
53+
54+
- [#57](https://github.com/bradygaster/squad/pull/57) — Implemented squad watch — Ralph watchdog
55+
56+
### [@digitaldrummerj](https://github.com/digitaldrummerj) (Justin James)
57+
Most recent: February 17, 2026
58+
59+
- [#89](https://github.com/bradygaster/squad/pull/89) — Added MCP Discord notifications
60+
61+
### [@danielscholl](https://github.com/danielscholl)
62+
Most recent: February 17, 2026
63+
64+
- [#80](https://github.com/bradygaster/squad/pull/80) — Implemented llms.txt docs build
65+
66+
### [@csharpfritz](https://github.com/csharpfritz) (Jeffrey T. Fritz)
67+
Most recent: February 13, 2026
68+
69+
- [#55](https://github.com/bradygaster/squad/pull/55) — Added logo for docs
70+
71+
## Community Contributors
72+
73+
These community members filed issues and started discussions that drove improvements to Squad:
74+
75+
### [@lbouriez](https://github.com/lbouriez) (Laurent)
76+
77+
- [#267](https://github.com/bradygaster/squad/issues/267) — Reported credential leak (led to secret guardrails sprint)
78+
- [#269](https://github.com/bradygaster/squad/issues/269) — Requested migration guide link
79+
80+
### [@eric-vanartsdalen](https://github.com/eric-vanartsdalen) (Eric VanArtsdalen)
81+
82+
- [#266](https://github.com/bradygaster/squad/issues/266) — Reported docs 403 error (led to docs build fix)
83+
84+
### [@LasseAtSparkron](https://github.com/LasseAtSparkron)
85+
86+
- [#265](https://github.com/bradygaster/squad/issues/265) — Reported ESM crash (led to Node 24 fix)
87+
88+
### [@craigb](https://github.com/craigb) (Craig Boucher)
89+
90+
- [#262](https://github.com/bradygaster/squad/issues/262) — Reported lint failure
91+
92+
### [@marchermans](https://github.com/marchermans) (Marc Hermans)
93+
94+
- [#247](https://github.com/bradygaster/squad/issues/247) — Reported installation failure
95+
96+
### [@dfberry](https://github.com/dfberry) / [@diberry](https://github.com/diberry) (Dina Berry)
97+
98+
- [#241](https://github.com/bradygaster/squad/issues/241) — Suggested docs member
99+
- [#228](https://github.com/bradygaster/squad/issues/228) — Reported CI failure
100+
- [#211](https://github.com/bradygaster/squad/issues/211) — Discussed management paradigms
101+
- [#157](https://github.com/bradygaster/squad/issues/157) — Suggested CFO member
102+
103+
### [@dkirby-ms](https://github.com/dkirby-ms) (Dale Kirby)
104+
105+
- [#239](https://github.com/bradygaster/squad/issues/239) — Reported terminal flickering (led to TUI fix)
106+
107+
### [@tomasherceg](https://github.com/tomasherceg) (Tomáš Herceg)
108+
109+
- [#237](https://github.com/bradygaster/squad/issues/237) — Reported CLI wiring bug
110+
- [#184](https://github.com/bradygaster/squad/issues/184) — Raised multi-PR commits issue
111+
112+
### [@uvirk](https://github.com/uvirk) (Uday)
113+
114+
- [#229](https://github.com/bradygaster/squad/issues/229) — Reported doctor command missing
115+
116+
### [@EirikHaughom](https://github.com/EirikHaughom) (Eirik Haughom)
117+
118+
- [#223](https://github.com/bradygaster/squad/issues/223) — Requested model configuration (led to per-model feature)
119+
120+
### [@tihomir-kit](https://github.com/tihomir-kit) (Tihomir Kit)
121+
122+
- [#214](https://github.com/bradygaster/squad/issues/214) — Reported node:sqlite error
123+
124+
### [@fboucher](https://github.com/fboucher) (Frank Boucher)
125+
126+
- [#207](https://github.com/bradygaster/squad/issues/207) — Reported non-root path resolution issue
127+
128+
### [@Pruthviraj36](https://github.com/Pruthviraj36)
129+
130+
- [#206](https://github.com/bradygaster/squad/issues/206) — Reported terminal blinking
131+
132+
### [@cobey](https://github.com/cobey) (Cody Beyer)
133+
134+
- [#196](https://github.com/bradygaster/squad/issues/196) — Requested global init mode
135+
136+
### [@dnoriegagoodwin](https://github.com/dnoriegagoodwin)
137+
138+
- [#195](https://github.com/bradygaster/squad/issues/195) — Reported upgrade version stamp bug
139+
140+
### [@wbreza](https://github.com/wbreza) (Wallace Breza)
141+
142+
- [#193](https://github.com/bradygaster/squad/issues/193) — Discussed ceremonies threshold
143+
144+
### [@MdeBruin93](https://github.com/MdeBruin93) (MdeBruin)
145+
146+
- [#192](https://github.com/bradygaster/squad/issues/192) — Reported npx stopped working
147+
148+
### [@KevinUK](https://github.com/KevinUK)
149+
150+
- [#188](https://github.com/bradygaster/squad/issues/188) — Reported upgrade doctor missing
151+
152+
### [@jbruce716](https://github.com/jbruce716)
153+
154+
- [#187](https://github.com/bradygaster/squad/issues/187) — Reported command not found
155+
156+
### [@frankhaugen](https://github.com/frankhaugen) (Frank R. Haugen)
157+
158+
- [#183](https://github.com/bradygaster/squad/issues/183) — Reported fetch failed error
159+
160+
### [@chrislomonico](https://github.com/chrislomonico)
161+
162+
- [#181](https://github.com/bradygaster/squad/issues/181) — Raised developer handover question
163+
164+
### [@johnwc](https://github.com/johnwc) (John Carew)
165+
166+
- [#176](https://github.com/bradygaster/squad/issues/176) — Requested multi-repo support
167+
168+
### [@swnger](https://github.com/swnger)
169+
170+
- [Discussion #169](https://github.com/bradygaster/squad/discussions/169) — Proposed skill-based orchestration (led to defineSkill())
171+
172+
### [@sturlath](https://github.com/sturlath)
173+
174+
- [#156](https://github.com/bradygaster/squad/issues/156) — Discussed cross-agent learning
175+
176+
### [@HemSoft](https://github.com/HemSoft)
177+
178+
- [#148](https://github.com/bradygaster/squad/issues/148) — Proposed GitHub Agent Workflows concept
179+
180+
---
181+
182+
**This page is updated with every release. No contribution goes unappreciated.**

0 commit comments

Comments
 (0)