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 startto both bootstrap and run the development server.
$ git clone https://github.com/netlify/netlify-cms $ cd netlify-cms $ yarn bootstrap
$ yarn start
Installs and bootstraps any CMS package dependencies.
$ yarn bootstrap
Watches all CMS packages and transpiles them on change.
$ yarn watch
Starts the development server. This task runs both the
$ yarn start
Removes all of the CMS package
clean script and removes all the
node_modules from the CMS packages.
clean script and builds the CMS packages.
build-preview scripts in each package and serves the resulting build locally.
Runs all the CMS package tests.
Formats code and docs according to our style guidelines.
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!
- 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.
yarn testand ensure the test suite passes.
yarn formatto 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.