Skip to content

Latest commit

 

History

History
39 lines (25 loc) · 1.11 KB

CONTRIBUTING.md

File metadata and controls

39 lines (25 loc) · 1.11 KB
Raw

Contributing

Welcome!

We're excited for your interest in WCC, and maybe even your contribution!

Setup

To develop for the project, you'll want to follow these steps:

  1. Have NodeJS LTS and / or use nvm (see below)
  2. Clone the repository
  3. Run npm ci

NVM

If you have NVM (Node Version Manager) installed, get the recommend node version:

And then running nvm use

$ nvm use

Local Development

The local development flow is based around building the docs website, using wcc in an SSG based workflow, and running tests.

Commands

There are the main tasks, but you can see them all listed in package.json#scripts.

  • npm run docs:dev - Builds the docs site for local development
  • npm start - Builds a production version of the docs site and serves it locally
  • npm run sandbox - Starts the sandbox app for live demos and testing
  • npm test - Run all the tests
  • npm test:tdd - Run all the tests in watch mode