Merge pull request #167 from marcellalcs/patch-1

docs: update docs
rbgfloripa · Nov 5, 2020 · dd66204 · dd66204
2 parents dc93a00 + 3e2a589
commit dd66204
Showing 1 changed file with 14 additions and 7 deletions.
diff --git a/packages/natds-icons/CONTRIBUTING.md b/packages/natds-icons/CONTRIBUTING.md
@@ -2,14 +2,21 @@
 
 Natura Design System - Icons
 
-To include a new Icon you should put the SVG in the `svg/` folder and build the application as usual. The new icon will be available in the generated font.
+## To include a new Icon - Adding the icon
 
-## Build
+- put the SVG in the `svg/` folder 
+- `yarn build:icons` 
+- Run the tests: `yarn tests`
+- Run regression tests: `yarn test:regression`
+  - This test should fail and you can check the diff at the path indicated on failure msg.
+- If the diff is as expected, you can update these tests: `yarn test:regression:update`
+- To finish, update the snapshot tests: `yarn tests:outputs -u`
 
-```sh
-yarn build
-```
 
-***
+## Open PR with changes
+- Create a branch with name "feat/branch_name"
+- Commit your changes adding at the commit name the type `feat`
+- Open the PR
+
+After perform all checks, your contribution will merged and publish :)
 
-See the scripts section in the package.json file for the complete list of tasks.