Skip to content

AgentMarginProject

Contributing

AgentMargin is an experimental open-source project under the MIT License. Contributions are welcome.

v0.3.0-alpha · experimentalLocalhost onlySource: CONTRIBUTING.md

Good first contributions

  • Improve installation instructions, or tell us where onboarding was confusing.
  • Add tests for cost accounting, idempotency, unknown pricing or tenant boundaries.
  • Report real edge cases from development and local experiments, without customer data.
  • Propose better SDK ergonomics, examples and observability.

Before building a large feature, share the use case so it can be discussed first.

Development

Requires Node.js 22.18+ (24 recommended).

bash
npm ci
npm run check
node --experimental-strip-types examples/calculate-margin.ts

For full PostgreSQL concurrency tests, follow the quickstart and the OrbStack verification guide in the repo. Never run integration tests against a production database.

Pull requests

  1. Keep changes focused. Explain the problem and the expected behavior.
  2. Add tests for behavior changes and run npm run check.
  3. Update the docs whenever public behavior or setup changes.
  4. Explain any change to security or pricing semantics.
  5. Never commit credentials, production data, .env files or personal information.

GitHub Actions adds PostgreSQL, source-file, dependency and Chromium checks. Passing CI is necessary, but it's not an independent security certification.

Open the repositoryReport a bug