Skip to content

docs: say what is welcome in a generated repo, and where it goes - #5

Merged
open-coder-ai-org merged 1 commit into
mainfrom
docs/contributor-readme
Sep 8, 2026
Merged

docs: say what is welcome in a generated repo, and where it goes#5
open-coder-ai-org merged 1 commit into
mainfrom
docs/contributor-readme

Conversation

@open-coder-ai-org

Copy link
Copy Markdown
Collaborator

What

README only, the one hand-written file here. The README said pull requests are closed and did not say what is welcome. A Contributing section now answers that with a four-row table: policy changes go to the catalog, "the guard did / did not block on my Cursor version" reports go to chock (which carries the witnessed-blocking claims these packages state), generator bugs go to chock, and README fixes belong here. A "Part of the open-coder-ai family" table before the license lists the sibling repositories with their roles; the same table lands in every public repository of the organisation.

The generated-only check is unaffected: README.md is not written by the publisher (that writes PLUGINS.md), so regenerating from the catalog produces no diff. No package, hook, lockfile or posture statement changes.

🤖 Generated with Claude Code


Generated by Claude Code

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>

Copy link
Copy Markdown
Collaborator Author

Generated-only / verify is red on this PR, and it is red on main for the same reason, not because of this change.

What fails: the first step, chock marketplace build --dist . --check --tree cursor, reports differs: PLUGINS.md. README.md is not an input to that build (the publisher writes PLUGINS.md, marketplace.json and the lockfile), so the diff here cannot move the result.

Why it is red on main: the workflow installs the framework from its floating main, which is now 0.8.0, and the catalog's .framework-ref now says v0.8.0; this tree was published from v0.7.0. The 0.8.0 emitter rewrote the preamble of PLUGINS.md. Running the same check locally on main (311ca7e) with framework 0.8.0 fails identically; main has had no push since the framework moved, which is why no red run shows there yet, and the sibling chock-claude-plugins repository shows the same step failing on its push to main on 2026-09-01.

The fix: a republish via publish.yml at the catalog's current ref, which rewrites PLUGINS.md and the packages together. That is a release action, and hand-committing a regenerated PLUGINS.md into a README PR would be exactly the drift this check exists to catch, so nothing is ported here. No re-run is requested: the failure is deterministic and reproduces locally.


Generated by Claude Code

@open-coder-ai-org
open-coder-ai-org marked this pull request as ready for review September 8, 2026 00:59
@open-coder-ai-org
open-coder-ai-org merged commit e03f96b into main Sep 8, 2026
4 of 5 checks passed
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