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.
Install yarn on your system: https://yarnpkg.com/en/docs/install
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
$ yarn bootstrap
$ yarn start
Bootstraps the monorepo.
$ yarn bootstrap
Watches all CMS packages and transpiles them on change.
$ yarn watch
Starts the development server. This task runs both the bootstrap
and watch
scripts.
$ yarn start
Removes all of the CMS package dist
directories.
yarn clean
Runs the clean
script and removes all the node_modules
from the CMS packages.
yarn reset
Runs the clean
script and builds the CMS packages.
yarn build
Runs the build
and build-preview
scripts in each package and serves the resulting build locally.
yarn build-preview
Runs all the CMS package tests.
yarn test
Formats code and docs according to our style guidelines.
yarn format
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.
- Fork the repo.
- Create a branch from
master
. If you're addressing a specific issue, prefix your branch name with the issue number. - If you've added code that should be tested, add tests.
- If you've changed APIs, update the documentation.
- Run
yarn test
and ensure the test suite passes. - Use
yarn format
to format and lint your code. - PR's must be rebased before merge (feel free to ask for help).
- PR should be reviewed by two maintainers prior to merging.
By contributing to Netlify CMS, you agree that your contributions will be licensed under its MIT license.