Skip to content

Latest commit

 

History

History
29 lines (18 loc) · 972 Bytes

CONTRIBUTING.md

File metadata and controls

29 lines (18 loc) · 972 Bytes
Raw

Prerequisites

Node.js >= v4 must be installed.

Installation

  • Running npm install in the components's root directory will install everything you need for development.

Demo Development Server

  • npm start will run a development server with the component's demo app at http://localhost:3000 with hot module reloading.

Building

  • npm run build will build the component for publishing to npm and also bundle the demo app.

  • npm run clean will delete built resources.

PRs

Thanks for wanting to contribute to RCW! Here are some pull request guidelines:

  • Follow current code structure
  • Keep all changes in one PR related to a single topic
  • Include a description
  • Using the demo, ensure that it still functions as expected
  • Don't forget to update readme/docs
  • Ensure npm run lint passes
    • npm run lint -- --fix will autofix where possible (in general, -- passes any flags following it)