Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
111 lines (81 loc) · 2.36 KB

CONTRIBUTING.md

File metadata and controls

111 lines (81 loc) · 2.36 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 npm
  $ npm i
  • you can use yarn instead
  $ yarn

install bit

perform bit import to fetch the project bit components.

  $ bit import
  • install command globally and link (in order to use the "bit-dev" command globaly and always use the latest development build)
  npm run dev-link

if you want your command to be different then the default (bit-dev) just add your favorite command name as an argument to the script

  npm run dev-link my-bit-dev-cmd-name

bit will install these commands in /usr/local/bin/ directory, so in order to remove them just use the bash rm command.

  rm /usr/local/bin/my-bit-dev-cmd-name

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

Unit Tests

  • run the unit tests
  npm test

End to End Tests

  • run the e2e tests (with default 'bit' command)
  npm run e2e-test
  • run e2e tests using bit-dev command
  npm run e2e-test --bit_bin=bit-dev

Use "--debug" flag to watch the running commands and the output. It might be a useful tool for debugging failed e2e tests.

Use "--with_ssh" flag to switch from exporting by using file-system to SSH approach. Make sure you are able to run 'ssh whoami@127.0.0.1' on your local.

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.
  5. Add your change to the CHANGELOG.md file at the [unreleased] section.

License

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