Skip to content

Contribute

Nerve is beta. Small, focused changes are easiest to reason about and review.

  • Keep shared API/event/policy/storage schemas in contracts and transport mechanics in protocol.
  • Prefer clean ownership changes over compatibility shims.
  • Add focused tests for public contracts, security/redaction, persistence/migrations, destructive operations, concurrency/state machines, recovery/failures, and complex orchestration.
  • Avoid tests solely for static exports, pass-through adapters, cosmetic presentation, or already-covered behavior.
  • Do not commit secrets, local state, generated release output, or machine-specific paths.
  • Keep public copy concise and evidence-backed.

Follow package AGENTS.md instructions, especially Workbench presentation and shared design-system boundaries.

Public pages live in packages/website/src/content/docs. Repository engineering sources remain in root docs/. Update the evidence inventory when changing catalogs, limits, shortcuts, CLI flags, storage, or security-sensitive behavior.

Do not open a public issue for a suspected vulnerability. Email the maintainer or use a private GitHub security advisory as described in SECURITY.md.

See the repository CONTRIBUTING.md for the canonical governance summary.