Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
51 lines (34 loc) · 1.03 KB

CONTRIBUTING.md

File metadata and controls

51 lines (34 loc) · 1.03 KB
Raw

Contributing to crewbit

Thanks for your interest in contributing.

Development setup

pnpm install

Run from source:

pnpm start -- ./examples/dev-junior.yaml
pnpm dry-run -- ./examples/dev-junior.yaml

Build the binary:

pnpm build
./crewbit ./examples/dev-junior.yaml

Code style

We use Biome for linting and formatting.

pnpm check   # lint + format in one pass
pnpm lint    # lint only
pnpm format  # format only

Run pnpm check before submitting a PR.

Adding a provider

  1. Create src/providers/<name>.ts implementing the IssueProvider interface.
  2. Register it in src/workflow.ts inside the createProvider switch.
  3. Add an example to examples/<name>-persona.yaml.

Pull requests

  • One logical change per PR.
  • Keep commits atomic and use Conventional Commits.
  • If you're adding a feature, add an example YAML that demonstrates it.

Reporting issues

Open an issue at https://github.com/dukex/crewbit/issues.