From 369128de702ef27eb5b3afcb88ff049941ca87cc Mon Sep 17 00:00:00 2001 From: Kerry Date: Thu, 9 Nov 2023 16:41:51 +1300 Subject: [PATCH] add documentation about changing and removing icons (#62) --- docs/icons.md | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/docs/icons.md b/docs/icons.md index 5fd9ece5..9abb1bd6 100644 --- a/docs/icons.md +++ b/docs/icons.md @@ -18,8 +18,18 @@ Transforms the icon to an XCode Image Set ## Synchronising icons -- Create the icon and add it to the Figma icon library https://www.figma.com/file/gkNXqPoiJhEv2wt0EJpew4/Compound-Icons?type=design&mode=design&t=lYEYAWjnNUSGFhV4-11 +- Create the icon and add it to the [Figma icon library](https://www.figma.com/file/gkNXqPoiJhEv2wt0EJpew4/Compound-Icons?type=design&mode=design&t=lYEYAWjnNUSGFhV4-11) + . Refer to [the guidelines for icon preparation](https://www.figma.com/file/gkNXqPoiJhEv2wt0EJpew4/Compound-Icons?type=design&node-id=280-6047&mode=design&t=wOCsc1FBoOz4YnJo-0). - Use [SVG Export](https://www.figma.com/community/plugin/814345141907543603) on Figma. Making sure to use `currentColor` so the icon can be tintable - Copy the icons to the `icons/` folder - Run `yarn build` at the root of the project or ask a maintainer to do this for you - Open a pull request against the `develop` branch + +## Removing or changing icons + +Removing an icon is a breaking change, and should be reflected in the changelog and a major change in package version. + +Renaming an icon is functionally the same as deleting an icon and adding another. This should be marked as a breaking +change. The changelog should include migration instructions. + +Visual changes to icons are considered a backwards compatible change (semver [patch](https://semver.org/)).