# Contiamo Icons collection

[![Netlify Status](https://api.netlify.com/api/v1/badges/99251e5d-723a-45c6-952c-0d0893666eba/deploy-status)](https://app.netlify.com/sites/contiamo-icons/deploys)

This repository regroups all Contiamo® Icons.

### How to add a new icon?

1. Create a new branch `git checkout -b name-of-my-branch`

1. Add a svg file in `./svg` folder.

Each file must be in **PascalCase**, the name of the file will become the name of the icon (`/svg/Add.svg` will become `<Icon.Add />`)

1. Commit the change `git commit -am "Add my beautiful icon!"`

1. Push to github `git push origin name-of-my-branch`

1. Create a new pull request on github

That's it! Everything else is fully automated :tada:

### Semantic versioning

This repository is following the [semver](https://semver.org/) convention.

To simplify:

- Patch an existing icon -> bump the patch number
- Add a new icon -> bump the minor number
- Delete or rename an icon -> bump the major number

### How is it working?

Everything works on CI, each push to master call `npm run build` and produce every `Icon.{name}` react components from the `svg` folder sources.

You can see all implementation details into `build.ts`