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 Node.js (LTS) and yarn on your system.
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 linting and Jest tests.
yarn test
Runs linting, Jest, and Cypress tests.
yarn test:all
Runs Cypress e2e tests.
yarn test:e2e
Runs Cypress e2e tests on watch mode with an open instance of Chrome.
yarn test:e2e:dev
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 in our community chat. 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.
yarn start
spawns a development server and uses dev-test/config.yml
and dev-test/index.html
to serve the CMS.
In order to debug a specific issue follow the next steps:
-
Replace
dev-test/config.yml
with the relevantconfig.yml
-
Change the content of
dev-test/index.html
to:
<!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>
- Run
yarn start
- Open
http://localhost:8080/
in the browser and you should have access to the CMS
When debugging the CMS with Git Gateway you must:
-
Have a Netlify site with Git Gateway and Netlify Identity enabled. An easy way to create such a site is to use a template, for example the Gatsby template
-
Tell the CMS the URL of your Netlify site using a local storage item. To do so:
- Open
http://localhost:8080/
in the browser - Write the below command and press enter:
localStorage.setItem('netlifySiteURL', 'https://yourwebsiteurl.netlify.app/')
- To be sure, you can run this command as well:
localStorage.getItem('netlifySiteURL')
- Refresh the page
- You should be able to log in via your Netlify Identity email/password
- Open
By contributing to Netlify CMS, you agree that your contributions will be licensed under its MIT license.