Skip to content

Latest commit

 

History

History
39 lines (22 loc) · 1.03 KB

CONTRIBUTING.md

File metadata and controls

39 lines (22 loc) · 1.03 KB
Raw

Getting Started

Clone the repo

git clone https://github.com/baianat/color-fns.git

Install dependencies

npm install

Make sure you are using npm v5.x

Hack away!

Code Style

We are using ESlint to enfore the style "Standard" with small modifications, for example we like our semicolons. Make sure to run npm run lint to make sure your code follows the style guide.

Testing

All functions must have a corresponding test file in the tests folder of the same name. Tests should have 100% coverage at all times. We are using jest for testing.

To run the tests:

npm run test

#or

npm t

Pull Requests

You can contribute anything you think is useful to the project, but it is recommended to discuss your ideas by either creating an issue or prefixing your PR with [WIP] and a checklist. The maintainers will be more than happy to respond to your contribution.

Please read the Code of conduct to avoid any miscommunications.