Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
31 lines (20 loc) · 1.48 KB

CONTRIBUTING.md

File metadata and controls

31 lines (20 loc) · 1.48 KB
Raw

Contributing

Appica Icons is developed in-house, and we're not accepting feature pull requests at this time. That said, your input genuinely helps the project:

  • Bug reports are very welcome — please open an issue — a small code example that shows the problem helps us fix it much faster.
  • Small fixes (typos, docs, obvious one-line bugs) are fine as PRs.
  • For anything larger — including new icon requests — open an issue first so we can discuss it before you invest time.

Working on a fix or reproducing an issue locally

Prerequisites

  • Node.js >= 20
  • pnpm >= 9 (npm install -g pnpm)

Setup and common commands

pnpm install

pnpm build          # build all packages (generates components from SVG assets, then bundles)
pnpm test           # run all test suites
pnpm typecheck      # type-check all packages
pnpm format         # format the codebase with Prettier

Package-specific commands can be run with a filter, e.g. pnpm --filter @appica/icons-react codegen to re-generate components from assets/ without bundling.

How it works

SVG sources live in assets/, organized by category. Each framework package under packages/ generates its components from them at build time and is published to npm independently. Generated component files (e.g. packages/react/src/icons/) are build output — edit the SVG sources or the codegen scripts, not the generated files.