Skip to content

Contributing Guide

Jump to bottom
Chris Diana edited this page Mar 4, 2021 · 3 revisions

Hey! We are really excited that you are interested in contributing to CMS.js. Before submitting your contribution though, please make sure to take a moment and read through the following guidelines.

Pull Request Guidelines

  • Checkout a topic branch from the main branch, and merge back against that branch.
  • Work in the src folder and DO NOT check in dist code in the commits.
  • It's OK to have multiple small commits as you work on the PR.
  • Before submitting a PR, please make sure you have fixed all ESLint errors.
  • If adding a new feature provide a convincing reason to add this feature. Ideally, you should open a suggestion issue first and have it approved before working on it.
  • If fixing bug add (fix #xxxx[,#xxxx]) (#xxxx is the issue id) in your PR title for a better release log, e.g. update entities encoding/decoding (fix #3899). Provide a detailed description of the bug in the PR along with the environment (OS, browser, version, etc).

Development Setup

After cloning the repo, run:

$ npm install

Then, start the development environment (with live reload, code watch and linting) by running:

$ npm start

Next, visit http://localhost:5000 in your browser and navigate to the examples directory. All changes made in the src directory will reflect here. There are several examples which you can use to test:

  • http://localhost:5000 - Basic CMS.js server configuration
  • http://localhost:5000/features - CMS.js server configuration with additional options enabled
  • http://localhost:5000/github - Basic CMS.js Github configuration
Clone this wiki locally