Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
78 lines (50 loc) · 1.79 KB

CONTRIBUTING.md

File metadata and controls

78 lines (50 loc) · 1.79 KB
Raw

Contributing

Contributions are welcome. Keep changes focused, include tests for behavior changes, and update the changelog when the change affects users.

Recommended Setup

Use Visual Studio Code with the Vue - Official extension.

Use Node.js 22.12.0 or newer in the same major line. GitHub Actions currently runs Node.js 22.12.0.

Install dependencies:

npm install

If Playwright browsers are missing locally, install them:

npx playwright install

Development

Start the local dev server:

npm run dev

Run a production build:

npm run build

The GitHub Pages production build uses the repository base path configured in vite.config.ts.

Tests

Run the full validation suite before opening a pull request:

npm test

Useful targeted commands:

npm run typecheck
npm run test:unit
npm run test:e2e
npm run test:visual

Update visual snapshots only when the visual change is intentional:

npm run test:visual:update

Do not commit generated Playwright output such as test-results/.

Changelog

Update CHANGELOG.md for user-facing changes, bug fixes, dependency upgrades, and notable internal testing/build changes. Use the existing version section unless you are preparing a new release.

Keep changelog text user-facing when possible. Put build, dependency, and test-only work under the internal runtime section.

Pull Requests

Before opening a pull request:

  • Keep unrelated refactors out of the change.
  • Add or update tests for changed behavior.
  • Run npm test and npm run build.
  • Include screenshots only when they help explain a UI change.
  • Reference related GitHub issues in the changelog or pull request body when applicable.