Skip to main content
Contributions to CC Safety Net are welcome. This page summarizes how to get set up and the conventions to follow. For the full guide, see CONTRIBUTING.md in the source repository.

​
Propose before you build

CC Safety Net has a focused scope: preventing coding agents from making accidental mistakes that cause data loss. It is not a general security-hardening or attack-prevention tool. Open an issue to discuss new detection rules, command categories, architectural changes, or configuration options before implementing them. Typo fixes and small bug fixes with an obvious solution can go straight to a pull request.

​
Prerequisites and setup

  • Bun — the required runtime and package manager (install guide)
  • Claude Code or OpenCode — for testing the plugin locally
git clone https://github.com/kenryu42/cc-safety-net.git
cd cc-safety-net
bun install
bun run build
bun run check
bun run check runs lint, typecheck, dead-code detection, an AST pattern scan, and the test suite with coverage. Run it before every pull request — it must pass with no errors.

​
Local testing

Build, then load the local plugin so you can test real blocks:
  • Claude Code: disable any installed safety-net plugin, exit Claude Code, then run claude --plugin-dir . from the repo root.
  • OpenCode: point the plugin[] array in ~/.config/opencode/opencode.json at the built file://.../cc-safety-net/dist/index.js, remove the npm cc-safety-net entry to avoid conflicts, and restart OpenCode.
Confirm a known block (git checkout -- README.md is blocked; git checkout -b test-branch is allowed).

​
Conventions

ConventionRule
Runtime / package managerBun only
Formatter / linterBiome
TypesType hints required on all functions; type | null preferred over type | undefined
File namingkebab-case
Function / type namingcamelCase functions, PascalCase types
ConstantsSCREAMING_SNAKE_CASE (for example reason constants)
New rules require tests with a minimum of 90% coverage. Do not bump the version in package.json — maintainers handle releases.

​
Getting help

  • bunx cc-safety-net doctor verifies your setup.
  • bunx cc-safety-net explain "<command>" shows step-by-step how a command is analyzed.
  • Check AGENTS.md in the source repo for architecture and conventions.
  • Open an issue for bugs or feature requests.