This document covers a basic set of guidelines for contributing to the Helix Network and its packages, which are hosted in the HelixNetwork Organization on GitHub. These are mostly guidelines, not fixed rules. Use your best judgment, and feel free to propose changes to this document in a pull request. Please be sure to read our code of conduct on: https://hlx.readme.io/docs/contribution-guidelines.
When contributing to a HelixNetwork repository, please first propose the changes you wish to make via an issue. If there is an existing issue that has been passed by the reviewers and addresses the change, please commit the change to your dedicated branch.
- Open issue, e.g. "Unexpected conversion result (#153)" (note that each issue has an unique id).
- Issue has been discussed and specs for implementation have been approved.
- Fork
devbranch todev-<feature>. - Implement changes and compile build, then commit to dev-conversion-patch. It may be a good idea to include the issue id, in this case #153 in the commit, e.g.
$ git commit -am "Fix conversion (#153)". - Push to
dev-<feature>and submit a pull request todev. - Pull request is reviewed and approved
dev and master are protected by the following policies:
- Temporarily repository maintainer has to approve changes
- At least one reviewer has to approve changes
- Commits have to be signed (tutorial)
- Status Checks: Pull Requests have to pass travis integration test