CONTRIBUTING

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

Setup

Install yarn on your system: https://yarnpkg.com/en/docs/install

$ git clone https://github.com/netlify/netlify-cms
$ cd netlify-cms
$ yarn

Building

$ npm run build

Testing

$ npm run test

$ npm run test:watch

$ npm run lint

Running the server

$ npm run start

Pull Requests

We actively welcome your pull requests.

Fork the repo and create your branch from master.
If you've added code that should be tested, add tests.
If you've changed APIs, update the documentation.
Ensure the test suite passes.
Make sure your code lints.
PR's must be rebased before merge (feel free to ask for help)
PR should be reviewed by two maintainers (@erquhart, @Benaiah, @tech4him1) prior to merging.

Add yourself as a contributor

This project follows the all contributors specification. To add yourself to the table of contributors on the README.md, please use the automated script as part of your PR:

yarn run add-contributor <YOUR_GITHUB_USERNAME>

Follow the prompt. If you've already added yourself to the list and are making a new type of contribution, you can run it again and select the added contribution type.

License

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

1.6 KiB Raw Blame History