Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
44 lines (29 loc) · 708 Bytes

CONTRIBUTING.md

File metadata and controls

44 lines (29 loc) · 708 Bytes

Contributing

Thanks for contributing to agent-email.

Development setup

  1. Install Bun (>=1.0.29).
  2. Clone the repository.
  3. Install dependencies:
bun install
  1. Run checks:
bun run check

Branches and commits

  • Use small focused changes.
  • Prefer descriptive commit messages.
  • Include tests for behavior changes.

Pull requests

Before opening a PR, ensure:

  • bun run build passes.
  • bun run test passes.
  • README/docs are updated when CLI behavior changes.

For maintainer publishing steps, see RELEASING.md.

Reporting issues

Include:

  • CLI command you ran.
  • Actual JSON output/error.
  • Expected behavior.
  • Bun version and OS.