|
1 | | -## Contributing |
| 1 | +# Contributing to fabric-chaincode-java |
2 | 2 |
|
3 | | -We welcome contributions to the Hyperledger Fabric Project in many forms, and |
4 | | -there's always plenty to do! |
| 3 | +We welcome contributions to the [Hyperledger Fabric](https://hyperledger-fabric.readthedocs.io) Project. There's always plenty to do! |
5 | 4 |
|
6 | | -Please visit the |
7 | | -[contributors guide](http://hyperledger-fabric.readthedocs.io/en/latest/CONTRIBUTING.html) in the |
8 | | -docs to learn how to make contributions to this exciting project. |
| 5 | +If you have any questions about the project or how to contribute, you can find us in the [fabric-java-chaincode](https://chat.hyperledger.org/channel/fabric-java-chaincode) Hyperledger Rocket.Chat channel. |
| 6 | + |
| 7 | +Here are a few guidelines to help you contribute successfully... |
| 8 | + |
| 9 | +## Issues |
| 10 | + |
| 11 | +We currently track bug reports using the [Hyperledger JIRA](https://jira.hyperledger.org/issues/?jql=project+%3D+FAB+AND+component+%3D+fabric-chaincode-java) tool. |
| 12 | + |
| 13 | +If you find a bug which we don't already know about, you can help us by creating a new issue describing the problem. Please include as much detail as possible to help us track down the cause. |
| 14 | + |
| 15 | +> **Note:** Please use Rocket.Chat instead of JIRA to ask questions. |
| 16 | +
|
| 17 | +## Fixes |
| 18 | + |
| 19 | +If you want to begin contributing code, looking through our open issues is a good way to start. Try looking for recent issues with detailed descriptions first, or ask us on Rocket.Chat if you're unsure which issue to choose. |
| 20 | + |
| 21 | +## Enhancements |
| 22 | + |
| 23 | +Make sure you have the support of the Hyperledger Fabric community before investing a lot of effort in project enhancements. For example, discuss your proposal on Rocket.Chat or open a JIRA issue for feedback before starting work. |
| 24 | + |
| 25 | +> **Note:** A more formal RFC process is under development for Hyperledger Fabric enhancement requests. |
| 26 | +
|
| 27 | +## Pull Requests |
| 28 | + |
| 29 | +We use our own forks and [Github Flow](https://guides.github.com/introduction/flow/index.html) to deliver changes to the code. Follow these steps to deliver your first pull request: |
| 30 | + |
| 31 | +1. [Fork the repository](https://guides.github.com/activities/forking/#fork) and create a new branch from `master`. |
| 32 | +2. If you've added code that should be tested, add tests! |
| 33 | +3. If you've added any new features or made breaking changes, update the documentation. |
| 34 | +4. Ensure all the tests pass. |
| 35 | +5. Include the JIRA issue number, a descriptive message, and the [Developer Certificate of Origin (DCO) sign-off](https://github.com/probot/dco#how-it-works) on all commit messages. |
| 36 | +6. [Issue a pull request](https://guides.github.com/activities/forking/#making-a-pull-request)! |
| 37 | +7. [Azure DevOps](https://dev.azure.com/Hyperledger/Fabric-Chaincode-Java) builds must succeed before the pull request can be reviewed and merged. |
| 38 | + |
| 39 | +## Coding Style |
| 40 | + |
| 41 | +Please to try to be consistent with the rest of the code and conform to checkstyle rules where they are provided. |
9 | 42 |
|
10 | 43 | ## Folder structure |
11 | 44 |
|
@@ -66,4 +99,12 @@ See our [Code of Conduct Guidelines](../blob/master/CODE_OF_CONDUCT.md). |
66 | 99 |
|
67 | 100 | Should you have any questions or concerns, please reach out to one of the project's [Maintainers](../blob/master/MAINTAINERS.md). |
68 | 101 |
|
69 | | -<a rel="license" href="http://creativecommons.org/licenses/by/4.0/"><img alt="Creative Commons License" style="border-width:0" src="https://i.creativecommons.org/l/by/4.0/88x31.png" /></a><br />This work is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by/4.0/">Creative Commons Attribution 4.0 International License</a>. |
| 102 | +## Hyperledger Fabric |
| 103 | + |
| 104 | +See the |
| 105 | +[Hyperledger Fabric contributors guide](http://hyperledger-fabric.readthedocs.io/en/latest/CONTRIBUTING.html) for more details, including other Hyperledger Fabric projects you may wish to contribute to. |
| 106 | + |
| 107 | +--- |
| 108 | + |
| 109 | +[](http://creativecommons.org/licenses/by/4.0/) |
| 110 | +This work is licensed under a [Creative Commons Attribution 4.0 International License](http://creativecommons.org/licenses/by/4.0/) |
0 commit comments