Skip to content

Lead the README with the security guardrails each plugin ships - #3

Closed
jothimani-rajendran wants to merge 1 commit into
mainfrom
openaicoder-claude/hopeful-ride-zjp8yl
Closed

jothimani-rajendran wants to merge 1 commit into
mainfrom
openaicoder-claude/hopeful-ride-zjp8yl

Conversation

@jothimani-rajendran

Copy link
Copy Markdown
Contributor

What

Reworks README.md (hand-written, not generated) so it leads with security:

  • Security-first header: the existing badges plus plugins (26), best-effort hooks (14), and the catalog's 48 policies, 1,179 eval cases and OWASP Agentic 10/10.
  • The refreshed hero GIF (same as the sibling repos), with a caption saying it shows commit-time refusal. This repo's docs/assets/hero.svg ("not yet witnessed") moves into the "How a refusal works in Devin" section.
  • What these plugins refuse: a table grouped by security area. It lists only the 14 packages published here, each marked best-effort guard or gate, with its catalog eval-case count. The 12 advisory packages and the catalog policies not packaged here are in collapsible lists.
  • Kept verbatim: Devin's own "currently best effort and fail open … don't rely on them for crucial guardrails yet" quote, the no-witnessed-install statement, the local-sessions-only and exit-code notes, and "You may already have this".
  • A family table linking all five plugin repos, and a Contributing table with concrete upstream first contributions.

Install steps are unchanged. This PR matches the structure of the sibling PRs in the claude, copilot, cursor and codex plugin repos.

Corrections

  • Verify it yourself: the recipe pinned --branch v0.9.3. It now reads the catalog's .framework-ref, which is what this repo's Generated-only workflow reads.
  • The README called itself "the one hand-written file here". SECURITY.md and .github/workflows/ are hand-written too, so the bullet now matches the sibling repos.

Why README.md is safe to edit here

The generator writes the packages and PLUGINS.md, not README.md. A test regeneration with chock 0.15.0 left the README unchanged. close-prs.yml only closes PRs from forks.

Checks

  • No workflow, tool or test in this repo reads README.md.
  • All relative links resolve (including docs/assets/hero.svg), and every table row has the right column count.

🤖 Generated with Claude Code

https://claude.ai/code/session_01LAxde3s5KW8N36kS8LF3er


Generated by Claude Code

Rework README.md around what the packages here refuse in this client:
a security-first header with badges, the refreshed hero GIF, a "What
these plugins refuse" table grouped by security area (only packages
published here, marked guard, gate or advisory, with catalog eval
counts), the advisory and not-yet-packaged policies in collapsible
lists, the client's own hook behaviour and fail-open notes, a family
table linking every sibling plugin repository, and concrete upstream
contribution routes.

Install steps and every client-specific claim about witnessed or
documented blocking are kept verbatim. The five plugin repositories now
share one README structure.

Also correct two stale statements: the verify recipe now reads the
framework ref from the catalog's .framework-ref, as the Generated-only
workflow does, instead of a hard-coded v0.9.3; and the README is no
longer called the only hand-written file, since SECURITY.md and the
workflows are hand-written too.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

Copy link
Copy Markdown
Contributor Author

Generated-only / verify is red, and not because of this PR. This PR changes only README.md, which chock plugin build / chock marketplace build never write. So the diff the check finds is in generated files this PR doesn't touch. main last passed this check on 2026-09-24 (run 35941943038), when the tree matched framework v0.11.2. The check rebuilds against the catalog's current main, which now declares framework v0.15.0 and newer policy versions. A fresh build of main alone would therefore differ too.

No fix fits inside this PR. The generated tree should only change through the Publish workflow (workflow_dispatch), which rebuilds from chock-catalog and commits the result. I didn't re-run the check because it's a deterministic diff and would fail the same way. Once Publish has run on main, merging main into this branch should turn it green.


Generated by Claude Code

Copy link
Copy Markdown
Contributor Author

Closing at the owner's request (2026-10-05). The README refresh will be redone once before launch, so that it matches the chock.sh site and the current labels.


Generated by Claude Code

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.

2 participants