Skip to content

Commit 9a20c72

Browse files
docs: add a Contributing section, evidence first; map the family
Every public README now carries the same family table (minus its own row) and a contributing section that says what a visitor can actually do from this repository, without widening any enforcement claim or typing a count by hand. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com> Signed-off-by: Open Coder AI <250249270+open-coder-ai@users.noreply.github.com>
1 parent e94f29e commit 9a20c72

1 file changed

Lines changed: 44 additions & 0 deletions

File tree

README.md

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -257,6 +257,36 @@ pip install agentseam
257257
Goose, Crush, OpenCode: adapters planned; the
258258
capability research is done and each is a config entry plus a matrix row.
259259

260+
## Contributing
261+
262+
The most valuable contribution needs no code. Most rows in the matrix above rest on vendor
263+
documentation rather than on anyone watching the agent run. If you have one of those agents
264+
installed, one command reports what your version actually does, and the result becomes a
265+
`verified` record with your handle on it:
266+
267+
```bash
268+
python3 tools/experiment.py run --agent <agent> --report \
269+
--agent-version <version> --reporter @yourhandle > report.json
270+
```
271+
272+
Paste it into an [evidence report](https://github.com/open-coder-ai/agentseam/issues/new?template=evidence-report.yml).
273+
A result that contradicts the matrix is the one we most want: it is a row we are getting
274+
wrong in public. The walk-through, including the capture probe for payload shapes, is in
275+
[CONTRIBUTING.md](CONTRIBUTING.md#contributing-evidence-you-do-not-need-to-write-code).
276+
277+
Other ways in:
278+
279+
- **An adapter for an agent that is missing.** Goose, Crush and OpenCode are researched and
280+
unbuilt; each is a config entry plus a matrix row. Start from the
281+
[adapter request](https://github.com/open-coder-ai/agentseam/issues/new?template=adapter_request.md) template and
282+
[CONTRIBUTING.md](CONTRIBUTING.md#adding-an-agent-adapter).
283+
- **A matrix correction.** A row that claims more than the agent does is the bug this project
284+
exists to prevent; the [matrix correction](https://github.com/open-coder-ai/agentseam/issues/new?template=matrix_correction.md)
285+
template is for exactly that.
286+
- **Bugs and docs.** Issues and PRs welcome. `pytest -q` and `ruff check .` are the whole
287+
local loop, the runtime path stays stdlib-only, and every commit is signed off
288+
(`git commit -s`).
289+
260290
## Design
261291

262292
- **stdlib only.** No dependencies, ever, in the adapter path — adapters must stay
@@ -271,4 +301,18 @@ capability research is done and each is a config entry plus a matrix row.
271301
[ARCHITECTURE.md](ARCHITECTURE.md) explains why those choices, what they cost, and the bug
272302
classes they exist to prevent.
273303

304+
## Part of the open-coder-ai family
305+
306+
Everything under [open-coder-ai](https://github.com/open-coder-ai) is built on one rule: a claim must match a
307+
mechanism. Where this repository sits among the others:
308+
309+
| Repository | What it is |
310+
| :--- | :--- |
311+
| [chock](https://github.com/open-coder-ai/chock) | The framework: write a policy once, enforce it on git hooks, CI, and every agent |
312+
| [chock-catalog](https://github.com/open-coder-ai/chock-catalog) | The policies, each graded by what it actually enforces |
313+
| [context-report](https://github.com/open-coder-ai/context-report) | A signed report format for whether a plugin, hook, skill or `AGENTS.md` actually works |
314+
| [chock-threat-intel](https://github.com/open-coder-ai/chock-threat-intel) | A weekly, human-reviewed threat digest scored against the catalog |
315+
| [chock-claude-plugins](https://github.com/open-coder-ai/chock-claude-plugins) · [copilot](https://github.com/open-coder-ai/chock-copilot-plugins) · [cursor](https://github.com/open-coder-ai/chock-cursor-plugins) · [codex](https://github.com/open-coder-ai/chock-codex-plugins) | The catalog compiled into each client's native plugin format; generated only, rebuilt and diffed in CI |
316+
| [chock-quickstart](https://github.com/open-coder-ai/chock-quickstart) · [chock-example](https://github.com/open-coder-ai/chock-example) | Template repositories: exactly what `chock init` leaves behind, and a working adoption with one policy per layer |
317+
274318
Apache-2.0.

0 commit comments

Comments
 (0)