Skip to content

Contributing

For Cursor IDE setup (rules, skills, agent handbook), see Cursor agents and AGENTS.md.

  1. Fork LewafaBV/lewicons.
  2. Add paths in scripts/mural-icon-paths.mjs and icons/{name}.json following design guidelines.
  3. Run pnpm install, pnpm icons:mural, pnpm lint:icons, and pnpm build.
  4. Attach 16 / 24 / 32px previews in your PR.

Scripts

CommandDescription
pnpm icons:muralRegenerate icons/*.svg from mural path catalog
pnpm lint:iconsValidate SVG contract (path-only mural style)
pnpm buildMuralize, generate packages, and compile React
pnpm docs:devLocal documentation site