Skip to content

Latest commit

 

History

History
10 lines (9 loc) · 1.08 KB

CONTRIBUTING.md

File metadata and controls

10 lines (9 loc) · 1.08 KB
Raw

Steps to contribute icons to grommet-icons

  1. Fork the grommet-icons project and clone.
  2. When adding new icons, export SVGs as stroke versions as opposed to outline. The SVG path should include stroke="#000" and stroke-width="2".
  3. Add your raw svg files in this folder (use the other raw svgs as a reference on how to structure your file content and naming conventions).
  4. Run yarn generate-icons to generate the react components from the raw svg files from your grommet-icons fork.
  5. Add exports of generated icon components in this file and the corresponding declarations for TypeScript in this file.
  6. Consider adding search metadata to this file to help finding your new icon.
  7. Run yarn test-update to recreate the test snapshot files.
  8. Share with the community by submitting a PR.