This file applies to the entire deck.gl-community repository. Directories may add more specific guidance in their own AGENTS.md files.
- Use the Yarn 4 workspace that ships with the repo. Install dependencies with
yarnand run scripts viayarn <script>from the repo root. Seepackage.jsonfor the canonical script list. - Prefer TypeScript and ES module syntax when authoring source files. Most packages ship dual ESM/CJS bundles via build tooling defined per workspace package.
- if any dependencies are changed, the yarn.lock file must be rebuilt by running
yarnin the root before committing.
- Run
yarn lintoryarn lint-fixbefore committing JavaScript/TypeScript changes. - Run the relevant Vitest project:
yarn test(Node),yarn test-browser, oryarn test-headlessas appropriate for your change.
- Follow the contribution flow in
docs/CONTRIBUTING.mdbefore landing breaking changes. - When adding or removing packages or examples, update any related documentation, sidebars, or release notes under
docs/.