Skip to content

Latest commit

 

History

History
49 lines (34 loc) · 1.14 KB

File metadata and controls

49 lines (34 loc) · 1.14 KB

Contributing

Thanks for helping improve Agent Contracts.

Project goals

This repository is intentionally narrow. Contributions should reinforce that shape.

Good contributions usually:

  • improve contract clarity
  • strengthen validation quality
  • improve CLI usability
  • tighten documentation
  • expand examples in realistic ways

Please avoid turning the project into:

  • a workflow engine
  • a generic agent runtime
  • a dashboard product
  • a database-backed platform

Local workflow

npm install
npm test
node dist/cli.js init ./contracts/example --template generic

If you are changing the CLI or validator behavior, please update examples or docs when that improves clarity.

Pull request guidance

  • Keep changes focused.
  • Prefer small, readable modules over speculative abstractions.
  • Preserve human-readable CLI output.
  • Add or update tests when behavior changes.
  • Document any meaningful contract model changes in docs/contract-spec.md.

Reporting issues

When filing issues, include:

  • the contract file or a minimal reproduction
  • the expected behavior
  • the actual behavior
  • why the current result is confusing or unsafe