Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
54 lines (39 loc) · 1.38 KB

CONTRIBUTING.md

File metadata and controls

54 lines (39 loc) · 1.38 KB
Raw

Contributing

Thanks for helping improve AI Dev Team.

Initial public release - no prior commit history.

Development

  1. Fork the repository.

  2. Create a branch for your change.

  3. Install dependencies (Node 22.19.0 or newer, pnpm 11.11.0, and Python 3 for the benchmark-helper unit tests):

    corepack enable
corepack prepare pnpm@11.11.0 --activate
pnpm install --frozen-lockfile

  4. For a running stack, generate local credentials and the sample repository, then start Compose (it uses ai-dev-team.example.yaml by default):

    ./scripts/init-local-env.sh
docker compose up --build

    Compose builds the browser-free Alpine/musl runtime runner by default. Use AI_DEV_TEAM_RUNNER_TARGET=compat only for a trusted repository that requires glibc. Set it to browser only when exercising visual verification or Playwright E2E; those paths fail clearly on both browser-free targets.

Verification

Run before opening a PR (CI runs the same checks):

pnpm audit:prod
pnpm typecheck
pnpm build
pnpm test

Pull Requests

Submit a PR with:

  • a short description of the problem and solution
  • any config changes needed to use the feature
  • test results

Keep the core independent of any specific deployment or customer setup. Do not include API keys, tokens, private keys, database URLs or production project identifiers.