Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
40 lines (28 loc) · 1.08 KB

CONTRIBUTING.md

File metadata and controls

40 lines (28 loc) · 1.08 KB
Raw

Contributing

Thanks for helping improve AMC WebUI.

Workflow

  1. Search existing issues and pull requests before opening a new one.
  2. Create focused issues with reproduction steps, environment details, and screenshots or logs when useful.
  3. Keep pull requests small and scoped to one behavior change when possible.
  4. Run the relevant checks before opening a pull request.

Local Development

Node.js 26 is recommended for local development. The repository includes .nvmrc and enables engine-strict; Node.js 24 is the minimum supported version. Run nvm use before installing dependencies if you want the recommended version.

nvm use
npm ci
npm run dev

Useful verification commands:

npm run typecheck
npm run lint
npm run test
npm run build

For end-to-end coverage:

npx playwright install --with-deps chromium
npm run test:e2e

Pull Requests

Include a short summary, verification notes, and screenshots for UI changes. If a change affects storage, model behavior, deployment, or user data migration, call that out explicitly in the PR body.