Skip to content

Latest commit

 

History

History
33 lines (22 loc) · 740 Bytes

CONTRIBUTING.md

File metadata and controls

33 lines (22 loc) · 740 Bytes

Contributing to camaro

Issues

  • State version of node/camaro/OS.
  • Include a minimal script which can reproduce the issue.

Pull Requests

  • Make sure all tests pass.
  • If new feature(s) is included, write test(s) for them as well.
  • Check the benchmark script to see if there's any performance regression.

Setup development environment

It's easier to have Docker installed for development.

npm install

# for fetching c++ dependencies using napa
npm run install-deps

# use docker to build. if you don't have Docker installed, you can use build.sh script
npm run build

# tests
npm run test