Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

CONTRIBUTING.md brought up to speed with latest node/npm version and default branch #673

Merged
merged 1 commit into from
Apr 26, 2021
Merged

CONTRIBUTING.md brought up to speed with latest node/npm version and default branch #673

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@ Want to contribute to Sitecore JavaScript Services? There are a few things you n

## Pre-requisites:

- `node.js` (8.11.3 or later)
- `npm` (5.x or later) installed (cmd `node -v` to test).
- `node.js` ([Active LTS](https://nodejs.org/en/about/releases/) version) installed (cmd `node -v` to test).
- `npm` (6.x or later) installed (cmd `npm -v` to test).

## Setting up

Expand Down Expand Up @@ -43,7 +43,7 @@ If you need to make code changes to the documentation site, follow these steps:
- Clone the forked repo to your local machine.
- From a terminal in the repo root: `cd docs`
- Create a feature branch from `master` for your changes. e.g. `git checkout -b my-feature-branch`
> Note: although `master` is the default branch for the JSS repo, documentation changes that pertain to the current release of JSS should be branched from `master`. The `master` branch contains the published / active documentation content. Changes related to the next release should be added to the `dev` branch.
> Note: although `dev` is the default branch for the JSS repo, documentation changes that pertain to the current release of JSS should be branched from `master`. The `master` branch contains the published / active documentation content. Changes related to the next release should be added to the `dev` branch.
- `npm install`
- `jss start` (to preview your changes locally)
- Make your changes
Expand Down