Skip to content

Latest commit

 

History

History
46 lines (30 loc) · 938 Bytes

CONTRIBUTING.md

File metadata and controls

46 lines (30 loc) · 938 Bytes
Raw

Contributing to Comet

General Process

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature_a)
  3. Commit your Changes (git commit -m 'Added new feature_a')
  4. Push to the Branch (git push origin feature_a)
  5. Open a Pull Request

Running the Project Locally

After cloning the project to your machine, to install the dependencies, run:

npm install

To run storybook, run:

npm run start

Running Unit Tests

To make sure your changes do not break any unit tests, run the following:

npm run test

Ensure to review the coverage directory for code coverage details.

Running Code Quality Checks

To make sure your changes adhere to additional code quality standards, run the following:

npm run lint
npm run format

Releasing packages

See the following for creating a new release: Releasing