Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
47 lines (32 loc) · 777 Bytes

CONTRIBUTING.md

File metadata and controls

47 lines (32 loc) · 777 Bytes

Contributing to AgentBox

Thanks for contributing.

Development setup

git clone https://github.com/cascade-protocol/agentbox.git
cd agentbox
pnpm install
cp .env.example .env
pnpm dev

Requirements

  • Node.js 24+
  • pnpm 9+
  • Docker + Docker Compose (for local Postgres and production-like runs)

Code quality

Run checks before opening a PR:

pnpm -w check

Commit style

Use conventional commits:

  • feat: ...
  • fix: ...
  • chore: ...
  • docs: ...

Optional scope is encouraged, for example feat(backend): ....

Pull requests

  • Keep PRs focused
  • Include rationale and testing notes
  • Update docs for behavior or API changes
  • Link related issues

By contributing, you agree your contributions are licensed under Apache-2.0.