From 8b86743c4520385d8830fe1f1200ced2b3a9940f Mon Sep 17 00:00:00 2001 From: Josh Wooding <12938082+joshwooding@users.noreply.github.com> Date: Mon, 18 Dec 2023 15:37:47 +0000 Subject: [PATCH] Add instructions around contributing icons (#2836) --- CONTRIBUTING.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2224c55c85c..398021dfe34 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -4,6 +4,19 @@ To do: intro. ## How to's +### How to add a new icon + +1. Add the icon to the `packages/icons/src/SVG` folder. The icon should be named using kebab casing e.g. `icon-name.svg`. +2. Navigate to `packages/icons` e.g. `cd packages/icons`. +3. Run `yarn build` to build the icons. +4. Write a changeset using `yarn changeset`, this should have the format: + +```md +Added: + +- IconName +``` + ### Prop deprecation To do.