Skip to content

Latest commit

 

History

History
226 lines (149 loc) · 6.48 KB

CONTRIBUTING.md

File metadata and controls

226 lines (149 loc) · 6.48 KB
Raw

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 Node.js (LTS) and yarn on your system.

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
yarn bootstrap

Run locally

yarn start

Available scripts

bootstrap

Bootstraps the monorepo.

yarn bootstrap

watch

Watches all CMS packages and transpiles them on change.

yarn watch

start

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

yarn start

clean

Removes all of the CMS package dist directories.

yarn clean

reset

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

yarn reset

build

Runs the clean script and builds the CMS packages.

yarn build

build-preview

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

yarn build-preview

test

Runs linting and Jest tests.

yarn test

test:all

Runs linting, Jest, and Cypress tests.

yarn test:all

test:e2e

Runs Cypress e2e tests.

yarn test:e2e

test:e2e:dev

Runs Cypress e2e tests on watch mode with an open instance of Chrome.

yarn test:e2e:dev

format

Formats code and docs according to our style guidelines.

yarn format

Pull Requests

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.

  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.

Debugging

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:

  1. Replace dev-test/config.yml with the relevant config.yml. If you want to test the backend, make sure that the backend property of the config indicates which backend you use (Github, Gitlab, Bitbucket etc) and path to the repo.
backend:
  name: github
  repo: owner-name/repo-name
  1. 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>

The most important thing is to make sure that Netlify CMS is loaded from the dist folder. This way, every time you make changes to the source code, they will be compiled and reflected immediately on localhost.

  1. Run yarn start
  2. Open 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:

  1. 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

  2. Tell the CMS the URL of your Netlify site using a local storage item. To do so:

    1. Open http://localhost:8080/ in the browser
    2. Open the Developer Console. Write the below command and press enter: localStorage.setItem('netlifySiteURL', 'https://yourwebsiteurl.netlify.app/')
    3. To be sure, you can run this command as well: localStorage.getItem('netlifySiteURL')
    4. Refresh the page
    5. You should be able to log in via your Netlify Identity email/password

Fine tune the way you run unit tests

There are situations where you would want to run a specific test file, or tests that match a certain pattern.

To run all the tests for a specific file, use this command:

yarn jest <filename or file path>

The first part of the command, yarn jest means running the locally installed version of jest. It is equivalent to running node_modules/.bin/jest.

Example for running all the tests for the file gitlab.spec.js: yarn jest gitlab.spec.js

Some test files like API.spec.js is available in several packages. You can pass a regexp pattern instead of file path to narrow down files.

Example for running all the tests for the file API.spec.js in the netlify-cms-backend-gitlab package:

yarn jest ".+backend-gitlab/.+/API.spec.js

To run a specific test in a file, add the flag --testNamePattern, or -t for short followed by a regexp to match your test name.

Example for running the test "should return true on project access_level >= 30" in the API.spec.js in netlify-cms-backend-gitlab package:

yarn jest -t "true on p" ".+backend-gitlab/.+/API.spec.js"

For more information about running tests exactly the way you want, check out the official documentation for Jest CLI.

License

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