Skip to content

Commit

Permalink
Add instructions around contributing icons (#2836)
Browse files Browse the repository at this point in the history
  • Loading branch information
joshwooding authored Dec 18, 2023
1 parent 596512b commit 8b86743
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

1 comment on commit 8b86743

@vercel
Copy link

@vercel vercel bot commented on 8b86743 Dec 18, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please sign in to comment.