From 7bb74aa7e4776fc0aca9cebba492946c8d055d96 Mon Sep 17 00:00:00 2001 From: Open Coder AI <250249270+open-coder-ai@users.noreply.github.com> Date: Tue, 8 Sep 2026 00:39:11 +0000 Subject: [PATCH] docs: say what is welcome in a generated repo, and where it goes 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 Signed-off-by: Open Coder AI <250249270+open-coder-ai@users.noreply.github.com> --- README.md | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) diff --git a/README.md b/README.md index b41e273..86ff752 100644 --- a/README.md +++ b/README.md @@ -69,6 +69,35 @@ chock init && chock sync --ci - **Best-effort, not a boundary:** guards are pattern-based filters. See [SECURITY.md](https://github.com/open-coder-ai/chock/blob/main/SECURITY.md). +## Contributing + +Pull requests that change packages here are closed automatically, and not because the +change is unwelcome: every package is compiled from the catalog, so an edit here would be +overwritten at the next publish and would carry none of a policy's checks. What is welcome, +and where it goes: + +| You want to | Go to | +| :--- | :--- | +| Fix or add a policy | [chock-catalog](https://github.com/open-coder-ai/chock-catalog/blob/main/CONTRIBUTING.md) — it reaches every client from there, including this one | +| Report that a guard did or did not block on your Codex version | an issue on [chock](https://github.com/open-coder-ai/chock/issues/new/choose), which records the witnessed-blocking claims these packages carry; "it fails open where you say it fails closed" is the most useful result you can send | +| Report a bug in how packages are generated | [chock](https://github.com/open-coder-ai/chock/issues/new/choose), where the emitter lives | +| Fix this README | here — it is the one hand-written file in the repository | + +## Part of the open-coder-ai family + +Everything under [open-coder-ai](https://github.com/open-coder-ai) is built on one rule: a claim must match a +mechanism. Where this repository sits among the others: + +| Repository | What it is | +| :--- | :--- | +| [chock](https://github.com/open-coder-ai/chock) | The framework: write a policy once, enforce it on git hooks, CI, and every agent | +| [chock-catalog](https://github.com/open-coder-ai/chock-catalog) | The policies, each graded by what it actually enforces | +| [agentseam](https://github.com/open-coder-ai/agentseam) | The primitives layer under chock: one handler API over every agent's hooks, with a capability matrix that carries its provenance | +| [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 | +| [chock-threat-intel](https://github.com/open-coder-ai/chock-threat-intel) | A weekly, human-reviewed threat digest scored against the catalog | +| [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) | The same catalog compiled for the other clients; generated only, like this one | +| [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 | + ## License Apache-2.0, same as the framework and the catalog.