REVOLVE CMS

CMS styleguide is use for REVOLVE's internal consoles. This repo is private to keep codebase from being public. We're using npmjs to pubish only our dist files. https://www.jsdelivr.com/ to link our consoles to the styleguide files. Please carefully follow instructions below:

Getting Started

1. Clone this repo
2. Install node_modules npm run ci
3. cd into the directory "revolve-cms"
4. Create a npmjs.com account
5. Add your registry user account by running npm adduser
6. Enter your npmjs credentials

SemVer

Semantic Versioning Specification. Understanding which version number to update:

Major

The major version should increase when we’ve introduced new functionality which breaks our API, i.e., increase this value when we’ve added a backward-incompatible change to our project. When this number is increased, we must reset the Minor and Patch numbers to 0.

For example, if we have a project that is on version 1.2.5 and we have introduced a breaking change under the SemVer scheme, we must set our new version number to 2.0.0.

Minor

We should increase our minor version when we’ve introduced new functionality which changes our API but is backward compatible, i.e., a non-breaking change. We can also opt to change the Minor version if we’ve made substantial changes to the internal code of our project.

Similarly, when we change the Minor version we should also reset the patch version to 0. For example, updating the Minor version of a project at 2.0.1 would set it to 2.1.0.

Patch

Under the SemVer specs, we reserve patch changes for backward-compatible bug fixes. A patch change should not involve any changes to the API.

SemVer Specs

Publishing an Update

We're versioning our files. We're using npm to update the version. When you're ready to commit your changes, follow steps below:

1. Stage files to repo git add .
2. Enter commit message git commit -m “commit message”
3. Update version with npm npm version <patch/minor/major> example for patch: npm version patch
4. Push the version's tag created by npm git push --tags
5. Push to repo git push
6. Publish to npm npm publish

Linking to files in npm

https://cdn.jsdelivr.net/npm/<npm-package@<version>/<path-to-file>/<file-name>

Example

https://cdn.jsdelivr.net/npm/[email protected]/dist/chrome.js https://cdn.jsdelivr.net/npm/[email protected]/dist/chrome.css