Skip to content

AGENTS.md

Latest commit

 

History

History
28 lines (18 loc) · 1011 Bytes

AGENTS.md

File metadata and controls

28 lines (18 loc) · 1011 Bytes

Repository Guidelines

This repository uses GitHub Actions for continuous integration. Contributors should replicate the CI steps locally before opening a pull request.

Local Environment Setup

Before running any tests or scripts, install dependencies and build the packages:

pnpm install
pnpm build

Testing and Linting

  1. Install dependencies with pnpm install.
  2. Build all packages with pnpm build.
  3. Verify documentation with pnpm docs:check.
  4. Run unit tests with pnpm test and example tests with pnpm test:examples.
  5. Lint the code using pnpm lint.

These steps must pass before you submit your PR.

Pull Request Requirements

  • PR titles must follow the conventional commit format and, when possible, include the affected module name. Examples: feat(browser): add feature or fix(plugin): correct bug.
  • The CI matrix runs on Node.js 18.17.x, 20.x, and 22.x. Ensure your code is compatible with these versions.
⚡