cryptocoins/CONTRIBUTING.md

Contributing guidelines

First of all, thank all of you who want to take some of your time to make Cryptocoins better. It's highly appreciated!

These guidelines were written to inform you about all the things needed for icon contributions, effectively saving time for everyone involved. Let's keep this short and to-the-point. If you have any doubt/questions, feel free to contact me.

tl;dr

1. fork the Cryptocoins repo
2. add/edit/rename icons in the SVG/ folder
   • when adding new coins, be sure to keep the SVG canvas dimensions the same as other icons'
   • keep the visual consistency of icons (paddings from borders etc.)
   • if needed, we prefer a bit stylized icons rather than 100% original logos (for example if some lines won't be visible on small sizes, make them thicker); some degree of stylization is accepted as well
   • final icon should be monochrome (black) SVG, single layer (don't use white shapes anywhere in the SVG!)
   • use the correct naming of ICON and ICON-alt (see other icons)
3. generate the webfont via running gulp
   • you'll need to yarn install or npm install first
   • get yarn or npm
4. define icons' main colors in webfont/cryptocoins-colors.css
5. add the icons (manually) to icons-demo.html preview
   • make sure the webfont displays newly icons added correctly (some editors output not-quite-compatible SVGs unfortunately)
6. add info about all the newly added icons to docs/changelog.md's updates section at the bottom
   • feel free to add your username as credit (see update v2.7)
7. commit your changes
8. submit a Pull Request back to the original repo – once approved, it will be merged