Contributing

Table of Contents

• Code of Conduct
• Getting Setup
• Scripts
  • Run tests
  • Run tests in jest --watch mode
  • Run tests, check package size, and report coverage
  • Check package size limit
  • Run webpack in --watch mode for development
  • Build a production bundle
  • Format source code
  • Lint source code
  • Generate documentation site
• Commits
  • Commitlint Rules:
• AUTHORS file

Code of Conduct

Before contributing, please read our code of conduct

Getting Setup

npm install # installs dependencies for bassdrop

Scripts

Run tests

npm test

Run tests in jest --watch mode

npm run test:watch

Run tests, check package size, and report coverage

npm run test:ci

Check package size limit

npm run size

Run webpack in --watch mode for development

npm start

Build a production bundle

npm run build

Format source code

npm run prettier

Lint source code

npm run lint

Generate documentation site

npm run documentation

NOTE: husky is used to run a precommit hook. This hook does the following:

• Formats code with prettier
• Lints code with eslint
• Runs tests with jest
• Generates documentation site inside ./docs with documentationjs
• Generates the README with emdaer

Commits

All commit messages must follow the Conventional Commits Specification which can be described like so:

type(scope?): subject
body?
footer?

Commitlint is setup to enforce this convention.

Commitlint Rules:

• @commitlint/config-angular: Enforces common “types” , casing, length rules etc..

Example:

fix(Next): Add more cat pics
Closes #123, Closes #456

AUTHORS file

If you would like, when making your PR, add yourself to the AUTHORS file by appending Name <githubusername>. Doing so will add your name to contributor details list in the Contributing section.