Skip to content

Latest commit

 

History

History
38 lines (28 loc) · 2.19 KB

CONTRIBUTING.md

File metadata and controls

38 lines (28 loc) · 2.19 KB

How to Contribute to this repository

We value contributions from the community and will do everything we can to 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 documentation, 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.

Contibuting a Helium Improvement Proposal (HIP)

HIPs are modeled off Bitcoin Improvement Proposals (BIPs) and has become a standard in the crypto world for open source development on both technical and economic issues.

HIPs serve several primary functions:

  • To make architecture changes
  • To make economic and token changes
  • To address cheating and security issues
  • To address meta-governance

HIPs are not:

  • Funding requests to The Helium Foundation
  • Foundation treasury management
  • How do I submit a HIP?: Open a 'pull request' in the HIP repository. DO NOT create an 'issue'. Your pull request signifies a HIP in draft status. HIPs in draft status should be discussed in #hip-general in the Helium Official Community. Draft HIPs will be addressed and managed by HIP editors. Please be sure to answer all of their questions appropriately. HIPs that do not work with HIP editors are seen as incomplete and are likely to be closed. Once your HIP is clear and has met all HIP requirements, HIPs are then open for deeper discussion with their own channels in the Official Helium Community. HIPs move to a vote after rough consensus that this HIP is appropriate for the community to vote on. There is never a guarantee your HIP will receive a channel or move to a vote.

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.