Skip to content
Kineticons

Project

Contributing

How to contribute to Kineticons: set up the repository, add an icon with its motion, and run the checks.

Set up

shell
git clone https://github.com/fabwaseem/kineticons.git
cd kineticons
pnpm install
pnpm build      # the packages
pnpm dev        # this site, http://localhost:5190

Add an icon

Icons live in batch files under scripts/motions/: each lists its icons and gives every one a motion of its own, and fill shapes where an outline is drawn open. Hand-drawn icons live in packages/core/src/icons/.

ts
// scripts/motions/n.ts
export const list: Entry[] = [
  ["BellRing", "bell-ring", "Bell ringing", "status", "swing", ["alert", "notify"], "The bell rings."],
];
export const motions = {
  "bell-ring": { note: "The bell swings from its top.", motion: { p0: { origin: "50% 0%", animation: "…" } } },
};

The rule for motion

The drawing acts: parts move against each other, lines draw themselves, shapes morph. Never only the whole icon.

Checks

pnpm check draws every icon in every style and checks every motion, and lists any badge that crowds a filled shape. Open a pull request when it passes.

Something unclear or missing? Open an issue.