Skip to content

Split CONTRIBUTING into public and harness tracks - #5

Merged
VladimirBrejcha merged 1 commit into
mainfrom
docs/contributing-tracks
Aug 18, 2026
Merged

Split CONTRIBUTING into public and harness tracks#5
VladimirBrejcha merged 1 commit into
mainfrom
docs/contributing-tracks

Conversation

@VladimirBrejcha

Copy link
Copy Markdown
Contributor

Step 4 of the public onboarding sequence. A small public patch can use Node.js 20 and the Node test suites without a Codex session directory. Maintainers and agent runs still use agent:context / agent:verify / agent:complete.

Why

CONTRIBUTING.md previously required agent:context and a Codex session directory before any edit. That blocked drive-by patches.

What changed

  • Public-patches track leads the page: Node.js 20, test:broker-core / test:client / test:harness-adoption, no harness session.
  • Maintainers and agent runs keep the existing harness commands. agent:complete enforcement is unchanged.
  • Front-door tests read the shipped CONTRIBUTING.md for both tracks.
  • Specs and README record the split.

Out of scope

GitHub Releases, public test CI, issue/PR templates, Homebrew formula/cask, npm publish. No changes to .agents/, agent-harness/, or scripts/validate.sh.

Verification

  • node --test docs/test/front-door.test.mjs passed (5 tests).
  • git diff origin/main -- .agents agent-harness scripts/validate.sh is empty.
  • agent:verify spec-only passed.
  • agent:complete passed for task-sessions/20260818-contributing-tracks.

Why:
A first-time public contributor was told to run agent:context and create
a Codex session directory before editing. That blocked small patches
that only need Node 20 and the Node test suites.

Changed:
CONTRIBUTING.md now leads with a public-patches track: Node.js 20 and
npm run test:broker-core, test:client, and test:harness-adoption, with
no harness session required. The maintainer and agent track still
documents agent:context, agent:verify, and agent:complete. Front-door
tests read the shipped page for both tracks. Specs and README record
the split. Harness enforcement is unchanged.

Verification:
node --test docs/test/front-door.test.mjs
npm run agent:verify -- --profile spec-only --paths CONTRIBUTING.md,docs/test/front-door.test.mjs,README.md,docs/getting-started.md,spec/agents.md,spec/build-and-test.md,spec/README.md --session-dir task-sessions/20260818-contributing-tracks

Affected:
CONTRIBUTING.md
docs/test/front-door.test.mjs
README.md
docs/getting-started.md
spec/agents.md
spec/build-and-test.md
spec/README.md

Refs:
https://github.com/fiveonecode/simulator-broker
spec/agents.md

Session:
task-sessions/20260818-contributing-tracks
@VladimirBrejcha
VladimirBrejcha merged commit c5ca01a into main Aug 18, 2026
1 check passed
@github-actions

Copy link
Copy Markdown

OpenCodeReview: Review skipped: no items were selected.

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