Skip to content

Latest commit

 

History

History
76 lines (57 loc) · 1.33 KB

CONTRIBUTING.md

File metadata and controls

76 lines (57 loc) · 1.33 KB

CONTRIBUTING

Contributions are always welcome, no matter how large or small. Before contributing, please read the code of conduct.

Setup

installation

  • install dependencies using yarn
  $ yarn
  • you can use npm instead
  $ npm i
  • install command globally and link (in order to use the "bit" command globaly and always use the latest development build)
  npm install -g
  npm link

Flow

npm install -g flow-bin flow-typed
  • install type definitions using flow-typed
  flow-typed install

build

  • build legacy and modern distributions:
  npm run build
  • use with watch, to run the build on every code modification
  npm run watch

test

  • run the unit tests
  npm  test

lint

  • run eslint
  npm run lint

Pull Requests

We actively welcome your pull requests.

  1. Fork the repo and create your branch from master.
  2. If you've added code that should be tested, add tests.
  3. Ensure the test suite passes.
  4. Make sure your code lints.

License

By contributing to Bit, you agree that your contributions will be licensed under its Apache2 license.