Skip to content

Latest commit

 

History

History
39 lines (33 loc) · 1.33 KB

CONTRIBUTING.md

File metadata and controls

39 lines (33 loc) · 1.33 KB
Raw

How to Contribute to this repository

Running helium-js locally

  1. Clone the repo and navigate into the folder
git clone https://github.com/helium/helium-js.git && cd helium-js
  1. Get everything installed
yarn && yarn bootstrap && yarn build
  1. Run the tests
yarn test

If everything went well, you should see a list of green lines that say "PASS" in your terminal. That should get you up and running!

About contributing

We value contributions from the community and will do everything we can go get them reviewed in a timely fashion. If you have code to send our way or a bug to report:

  • Contributing Code: If you have new code or a bug fix, fork this repo, create a logically-named branch, and submit a PR against this repo. Include a write up of the PR with details on what it does.

  • Reporting Bugs: Open an issue against this repo with as much detail as you can. At the very least you'll include steps to reproduce the problem.

This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant Code of Conduct.

Above all, thank you for taking the time to be a part of the Helium community.