|
| 1 | +### Welcome |
| 2 | + |
| 3 | +We welcome contributions to the Hyperledger Project in many forms, and there's always plenty to do! |
| 4 | + |
| 5 | +First things first, please review the Hyperledger Project's [Code of Conduct](https://github.com/hyperledger/hyperledger/wiki/Hyperledger-Project-Code-of-Conduct) before participating. It is important that we keep things civil. |
| 6 | + |
| 7 | +### Getting help |
| 8 | +If you are looking for something to work on, or need some expert assistance in debugging a problem or working out a fix to an issue, our [community](https://www.hyperledger.org/community) is always eager to help. We hang out on [Slack](https://hyperledgerproject.slack.com/), IRC (#hyperledger on freenode.net) and the [mailing lists](http://lists.hyperledger.org/). Most of us don't bite ;-) and will be glad to help. |
| 9 | + |
| 10 | +### Requirements and Use Cases |
| 11 | +We have a [Requirements WG](https://github.com/hyperledger/hyperledger/wiki/Requirements-WG) that is documenting use cases and from those use cases deriving requirements. If you are interested in contributing to this effort, please feel free to join the discussion in [slack](https://hyperledgerproject.slack.com/messages/requirements/). |
| 12 | + |
| 13 | +### Reporting bugs |
| 14 | +If you are a user and you find a bug, please submit an [issue](https://github.com/hyperledger/fabric/issues). Please try to provide sufficient information for someone else to reproduce the issue. One of the project's maintainers should respond to your issue within 24 hours. If not, please bump the issue and request that it be reviewed. |
| 15 | + |
| 16 | +### Fixing issues and working stories |
| 17 | +Review the [issues list](https://github.com/hyperledger/fabric/issues) and find something that interests you. You could also check the ["help wanted"](https://github.com/hyperledger/fabric/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22) list. It is wise to start with something relatively straight forward and achievable. Usually there will be a comment in the issue that indicates whether someone has already self-assigned the issue. If no one has already taken it, then add a comment assigning the issue to yourself, eg.: ```I'll work on this issue.```. Please be considerate and rescind the offer in comments if you cannot finish in a reasonable time, or add a comment saying that you are still actively working the issue if you need a little more time. |
| 18 | + |
| 19 | +We are using the [GitHub Flow](https://guides.github.com/introduction/flow/) process to manage code contributions. If you are unfamiliar, please review that link before proceeding. |
| 20 | + |
| 21 | +To work on something, whether a new feature or a bugfix: |
| 22 | + 1. Create a [fork](https://help.github.com/articles/fork-a-repo/) (if you haven't already) |
| 23 | + |
| 24 | + 2. Clone it locally |
| 25 | + ``` |
| 26 | + git clone https://github.com/yourid/fabric.git |
| 27 | + ``` |
| 28 | + |
| 29 | + 3. Add the upstream repository as a remote |
| 30 | + ``` |
| 31 | + git remote add upstream https://github.com/hyperledger/fabric.git |
| 32 | + ``` |
| 33 | + |
| 34 | + 4. Create a branch |
| 35 | + Create a descriptively-named branch off of your cloned fork ([more detail here](https://help.github.com/articles/syncing-a-fork/)) |
| 36 | + ``` |
| 37 | + cd fabric |
| 38 | + git checkout -b issue-nnnn |
| 39 | + ``` |
| 40 | + |
| 41 | + 5. Commit your code |
| 42 | + |
| 43 | + Commit to that branch locally, and regularly push your work to the same branch on the server. |
| 44 | + |
| 45 | + 6. Commit messages |
| 46 | + |
| 47 | + Commit messages must have a short description no longer than 50 characters followed by a blank line and a longer, more descriptive message that includes reference to issue(s) being addressed so that they will be automatically closed on a merge e.g. ```Closes #1234``` or ```Fixes #1234```. |
| 48 | + |
| 49 | + 7. Pull Request (PR) |
| 50 | + |
| 51 | + **Note:** Each source file must include a license header for the Apache Software License 2.0. A template of that header can be found [here](https://github.com/hyperledger/fabric/blob/master/docs/dev-setup/headers.txt). |
| 52 | + |
| 53 | + When you need feedback or help, or you think the branch is ready for merging, open a pull request (make sure you have first successfully built and tested with the [Unit and Behave Tests](docs/dev-setup/install.md#3-test)). |
| 54 | + |
| 55 | + _Note: if your PR does not merge cleanly, use ```git rebase master``` in your feature branch to update your pull request rather than using ```git merge master```_. |
| 56 | + |
| 57 | + 8. Did we mention tests? All code changes should be accompanied by new or modified tests. |
| 58 | + |
| 59 | + 9. Continuous Integration (CI): Be sure to check [Travis](https://travis-ci.org/) or the Slack [#fabric-ci-status](https://hyperledgerproject.slack.com/messages/fabric-ci-status) channel for status of your build. You can re-trigger a build on [Jenkins](https://jenkins.io/) with a PR comment containing `reverify jenkins`. |
| 60 | + |
| 61 | + **Note:** While some underlying work to migrate the build system from Travis to Jenkins is taking place, you can ask the [maintainers](https://github.com/hyperledger/fabric/blob/master/MAINTAINERS.txt) to re-trigger a Travis build for your PR, either by adding a comment to the PR or on the [#fabric-ci-status](https://hyperledgerproject.slack.com/messages/fabric-ci-status) Slack channel. |
| 62 | + |
| 63 | + 10. Any code changes that affect documentation should be accompanied by corresponding changes (or additions) to the documentation and tests. This will ensure that if the merged PR is reversed, all traces of the change will be reversed as well. |
| 64 | + |
| 65 | +After your Pull Request (PR) has been reviewed and signed off, a maintainer will merge it into the master branch. |
| 66 | + |
| 67 | +## Coding guidelines |
| 68 | + |
| 69 | +### Coding Golang <a name="coding-go"></a> |
| 70 | +- We code in Go™ and strictly follow the [best practices](http://golang.org/doc/effective_go.html) |
| 71 | +and will not accept any deviations. You must run the following tools against your Go code and fix all errors and warnings: |
| 72 | + - [golint](https://github.com/golang/lint) |
| 73 | + - [go vet](https://golang.org/cmd/vet/) |
| 74 | + - [goimports](https://godoc.org/golang.org/x/tools/cmd/goimports) |
| 75 | + |
| 76 | + ## Generating gRPC code <a name="gRPC"></a> |
| 77 | + |
| 78 | + If you modify any `.proto` files, run the following command to generate/update the respective `.pb.go` files. |
| 79 | + |
| 80 | + ``` |
| 81 | + cd $GOPATH/src/github.com/hyperledger/fabric |
| 82 | + make protos |
| 83 | + ``` |
| 84 | + |
| 85 | + ## Adding or updating Go packages <a name="vendoring"></a> |
| 86 | + |
| 87 | + The Hyperledger Fabric Project uses Go 1.6 vendoring for package management. This means that all required packages reside in the `vendor` folder within the fabric project. Go will use packages in this folder instead of the GOPATH when the `go install` or `go build` commands are executed. To manage the packages in the `vendor` folder, we use [Govendor](https://github.com/kardianos/govendor), which is installed in the Vagrant environment. The following commands can be used for package management: |
| 88 | + |
| 89 | + ``` |
| 90 | + # Add external packages. |
| 91 | + govendor add +external |
| 92 | +
|
| 93 | + # Add a specific package. |
| 94 | + govendor add github.com/kardianos/osext |
| 95 | +
|
| 96 | + # Update vendor packages. |
| 97 | + govendor update +vendor |
| 98 | +
|
| 99 | + # Revert back to normal GOPATH packages. |
| 100 | + govendor remove +vendor |
| 101 | +
|
| 102 | + # List package. |
| 103 | + govendor list |
| 104 | + ``` |
| 105 | + |
| 106 | +### Becoming a maintainer |
| 107 | +This project is managed under open governance model as described in our [charter](https://www.hyperledger.org/about/charter). Projects or sub-projects will be lead by a set of maintainers. New projects can designate an initial set of maintainers that will be approved by the Technical Steering Committee when the project is first approved. The project's maintainers will, from time-to-time, consider adding a new maintainer. An existing maintainer will post a pull request to the [MAINTAINERS.txt](MAINTAINERS.txt) file. If a majority of the maintainers concur in the comments, the pull request is then merged and the individual becomes a maintainer. |
| 108 | + |
| 109 | +### Legal stuff |
| 110 | + |
| 111 | +**Note:** Each source file must include a license header for the Apache Software License 2.0. A template of that header can be found [here](https://github.com/hyperledger/fabric/blob/master/docs/dev-setup/headers.txt). |
| 112 | + |
| 113 | +We have tried to make it as easy as possible to make contributions. This applies to how we handle the legal aspects of contribution. We use the same approach—the [Developer's Certificate of Origin 1.1 (DCO)](docs/biz/DCO1.1.txt)—that the Linux® Kernel [community](http://elinux.org/Developer_Certificate_Of_Origin) uses to manage code contributions. |
| 114 | +We simply ask that when submitting a pull request, the developer must include a sign-off statement in the pull request description. |
| 115 | + |
| 116 | +Here is an example Signed-off-by line, which indicates that the submitter accepts the DCO: |
| 117 | + |
| 118 | +``` |
| 119 | +Signed-off-by: John Doe <[email protected]> |
| 120 | +``` |
0 commit comments