Skip to content

CONTRIBUTING.md

Latest commit

聽

History

History
39 lines (31 loc) 路 979 Bytes

CONTRIBUTING.md

File metadata and controls

39 lines (31 loc) 路 979 Bytes
Raw

Contributing

Setup

bun install

Development

bun run check-types   # Type check
bun run test          # Run tests
bun run test:watch    # Run tests in watch mode
bun run build         # Bundle with ncc
bun run all           # Type check + test + build

Making changes

  1. Create a branch from main
  2. Make your changes in src/
  3. Add or update tests in __tests__/
  4. Run bun run all to verify everything passes
  5. Commit both src/ and dist/ changes (the check-dist CI workflow enforces this)
  6. Open a PR against main

Project structure

src/
  index.ts      # Entry point
  main.ts       # Orchestrator: reads inputs, coordinates everything
  checker.ts    # Runs babel-plugin-react-compiler, collects events
  reporter.ts   # Builds Markdown report and GitHub annotations
  comment.ts    # PR comment create/update/delete
  files.ts      # Changed-file detection and glob filtering
  types.ts      # Shared types