Permalink
Find file Copy path
142 lines (88 sloc) 2.95 KB

CONTRIBUTING

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

For details on contributing to documentation, see Website Directory Readme.

Setup

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

Install dependencies

Only required on the first run, subsequent runs can use yarn start to both bootstrap and run the development server.

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

Run locally

$ yarn start

Available scripts

bootstrap

Installs and bootstraps any CMS package dependencies.

Usage

$ yarn bootstrap

watch

Watches all CMS packages and transpiles them on change.

Usage

$ yarn watch

start

Starts the development server. This task runs both the bootstrap and watch scripts.

Usage

$ yarn start

clean

Removes all of the CMS package dist directories.

Usage

yarn clean

reset

Runs the clean script and removes all the node_modules from the CMS packages.

Usage

yarn reset

build

Runs the clean script and builds the CMS packages.

Usage

yarn build

build-preview

Runs the build and build-preview scripts in each package and serves the resulting build locally.

Usage

yarn build-preview

test

Runs all the CMS package tests.

Usage

yarn test

format

Formats code and docs according to our style guidelines.

Usage

yarn format

Pull Requests

We actively welcome your pull requests!

If you need help with Git or our workflow, please ask on Gitter.im. We want your contributions even if you're just learning Git. Our maintainers are happy to help!

Netlify CMS uses the Forking Workflow + Feature Branches. Additionally, PR's should be rebased on master when opened, and again before merging.

  1. Fork the repo.
  2. Create a branch from master. If you're addressing a specific issue, prefix your branch name with the issue number.
  3. If you've added code that should be tested, add tests.
  4. If you've changed APIs, update the documentation.
  5. Run yarn test and ensure the test suite passes.
  6. Use yarn format to format and lint your code.
  7. PR's must be rebased before merge (feel free to ask for help).
  8. PR should be reviewed by two maintainers prior to merging.

License

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