Skip to content
This repository has been archived by the owner on Oct 9, 2023. It is now read-only.

Commit

Permalink
[NO-JIRA] Update contributing guide
Browse files Browse the repository at this point in the history
  • Loading branch information
George Gillams committed May 8, 2019
1 parent 22d218c commit 6c3f400
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,10 +63,20 @@ We recommend that you install [a plugin to your editor](https://eslint.org/docs/

## Getting started

### Cloning

`backpack-docs` makes use of submodules. Run `git clone --recursive git@github.com:Skyscanner/backpack-docs.git` to clone the repo.

The `--recursive` flag will ensure that you also clone all necessary submodules to run the docs locally.

For more help using submodules, see the [more detailed Submodules section](#submodules)

### Install dependencies

Run `npm install` to install dependencies from npm.

Then use `npm run build-backpack` to install dependencies for the web submodule, and ensure everything is built.

#### Backpack documentation

When adding documentation for a new component:
Expand Down

0 comments on commit 6c3f400

Please sign in to comment.