Skip to content

Latest commit

 

History

History
40 lines (27 loc) · 1.73 KB

CONTRIBUTING.md

File metadata and controls

40 lines (27 loc) · 1.73 KB
Raw

Contributing to Simple Icons Font

Simple Icons welcomes contributions and corrections. Before contributing, please make sure you have read the guidelines below. If you decide to contribute anything, please do the following:

  1. Fork this repository
  2. Create a new branch from the latest develop
  3. Start hacking on the new branch
  4. Commit and push to the new branch
  5. Make a pull request

If you want to request an icon, please open an issue here.

Local Development

Building Font Locally

  • Make sure you have NodeJS installed. At least version 12.0.0 is required.
  • Install the dependencies using $ npm install.
  • Build the font using $ npm run build.
  • The font files can be found in the font/ directory.

Testing Font Locally

  • Make sure you have NodeJS installed. At least version 12.0.0 is required.
  • Install the dependencies using $ npm install.
  • Build the font and the test page using $ npm test.
  • Your browser will be opened at http://localhost:8000/ where all icons should be displayed.

Versioning

This package is being versioned analog to the simple-icons package, the details of which can be found in the contributing guidelines.

Additionally, patches may be used for non-breaking improvements to the font and major releases may be used to introduce breakings changes beyond removed icons.