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.
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 yarn bootstrap
Bootstraps the monorepo.
Watches all CMS packages and transpiles them on change.
Starts the development server. This task runs both the
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 linting and Jest tests.
Runs linting, Jest, and Cypress tests.
Runs Cypress e2e tests.
Runs Cypress e2e tests on watch mode with an open instance of Chrome.
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 in our community chat. 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.
yarn start spawns a development server and uses
dev-test/index.html to serve the CMS.
In order to debug a specific issue follow the next steps:
dev-test/config.ymlwith the relevant
Change the content of
<!DOCTYPE html> <html> <head> <meta charset="utf-8" /> <title>Netlify CMS</title> </head> <body> <script src="dist/netlify-cms.js"></script> <!-- <script> // this is the place to add CMS customizations if you need to, e.g. CMS.registerPreviewTemplate('posts', PostPreview); </script> --> </body> </html>
http://localhost:8080/in the browser and you should have access to the CMS
Debugging Git Gateway
When debugging the CMS with Git Gateway you must:
Tell the CMS the URL of your Netlify site using a local storage item. To do so:
http://localhost:8080/in the browser
- Write the below command and press enter:
- To be sure, you can run this command as well:
- Refresh the page
- You should be able to log in via your Netlify Identity email/password
By contributing to Netlify CMS, you agree that your contributions will be licensed under its MIT license.