Skip to content

Commit

Permalink
update contributing doc
Browse files Browse the repository at this point in the history
  • Loading branch information
couetilc committed Jul 22, 2024
1 parent 19ca9c8 commit 676e8ed
Showing 1 changed file with 6 additions and 12 deletions.
18 changes: 6 additions & 12 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -128,18 +128,6 @@ make the final svg look neater:
https://github.com/couetilc/react-social-icons, where it will be reviewed
and merged. Thank you for contributing!

### Optimizing the SVG

Use [`svgo`](https://github.com/svg/svgo) to optimize the size of the icon you
are introducing. We include a useful script that will do this for you.

```sh
node optimize.mjs
```

Be sure to perform a visual check of your icon after optimizing to avoid any
visual regressions (e.g. use `./cli info:visual`).

## Writing and Running Tests

Any feature or bugfix _must_ have an accompanying test.
Expand Down Expand Up @@ -224,6 +212,12 @@ Run test:
./cli test:dep
```

### SVG Optimizations

[`svgo`](https://github.com/svg/svgo) is used in the rollup pipeline to
optimize the size of the icon you are introducing. Check the final look of your
icon to avoid any visual regressions.

## Making a PR

Describe your feature or bugfix, include a test or screenshot where applicable,
Expand Down

0 comments on commit 676e8ed

Please sign in to comment.