Contributing to Weftmap

🌐 Language: English · Español

Thanks for your interest! This guide covers the essentials.

Setup

pnpm install
pnpm dev

All of these must pass (it's what CI runs):

pnpm lint
pnpm typecheck
pnpm test
pnpm build

main is protected: no direct pushes. Work on a branch and open a Pull Request.
A PR needs CI green and at least one approval to merge.
Commits follow Conventional Commits: feat:, fix:, refactor:, docs:, test:, chore:.

This is the most valuable kind of contribution. The steps are in the README. Always include an analyzer test.

We welcome translations to make Weftmap accessible worldwide! To add a translation:

Register the new locale code (e.g., fr) in src/i18n/config.ts.
Copy src/i18n/dictionaries/en.json to src/i18n/dictionaries/<locale>.json and translate the values.
Run pnpm test to verify the translation dictionary matches the source template keys.