Skip to content

Latest commit

 

History

History
39 lines (30 loc) · 1.61 KB

CONTRIBUTING.md

File metadata and controls

39 lines (30 loc) · 1.61 KB
Raw

Contributing

Please note we have a code of conduct, please follow it in all your interactions with the project.

Adding colors

  1. Only update the src/colornames.csv file and run npm run build or request access to our shared google spreadsheet
  2. Make sure the names you commit are not racist or offensive or a protected brand name (No Facebook Blue, Coca Cola Red etc.., no nationality or tan etc..).
  3. Read the "Rules for new color names" directly below
  4. Make sure that neither name nor hex value of your added colors are already in use. npm run test will test that for you.
  5. Update the README.md with the source of your colors, unless you invented that color, in this case add yourself to the contributors in the README.md

We use automated semantic versioning make sure to use git cz (or npm run commit).

Rules for new color names

  • No duplicate names or hex values.
  • No racist names
  • No offensive names
  • No obscene names 💩
  • No protected brand-names (Facebook Blue, Coca Cola Red)
  • No enumerations (Grey 1, Grey 2, Grey 3, Grey 4)
  • British English spelling (ex. Grey not Gray), unless its something U.S. typical.
  • Capitalize colors: Kind of Orange
  • Prefer common names, especially when adding colors of flora and fauna (plants and animals ;) ) ex. Venus Slipper Orchid instead of Paphiopedilum.

Attribution

This Code of Conduct is adapted from the Contributor Covenant, version 1.4, available at http://contributor-covenant.org/version/1/4