spearhead-statuskit/CONTRIBUTING.md
David Calavera d277ab3f82
Remove yarn to install dependencies.
We can reconsider using it when it becomes more stable.

Signed-off-by: David Calavera <david.calavera@gmail.com>
2016-12-09 10:41:41 -08:00

823 B

CONTRIBUTING

Contributions are always welcome, no matter how large or small. Before contributing, please read the code of conduct.

Setup

$ git clone https://github.com/netlify/netlify-statuskit
$ cd netlify-statuskit
$ npm install

Building

$ npm run build

Testing

$ npm run test

Runing the server

$ npm run start

Pull Requests

We actively welcome your pull requests.

  1. Fork the repo and create your branch from master.
  2. If you've added code that should be tested, add tests.
  3. If you've changed APIs, update the documentation.
  4. Ensure the test suite passes.
  5. Make sure your code lints.

License

By contributing to Netlify StatusKit, you agree that your contributions will be licensed under its MIT license.