Skip to content

Latest commit

 

History

History
71 lines (44 loc) · 3.95 KB

CONTRIBUTING.md

File metadata and controls

71 lines (44 loc) · 3.95 KB
Raw

Contributing to fabric-chaincode-java

We welcome contributions to the Hyperledger Fabric Project. There's always plenty to do!

If you have any questions about the project or how to contribute, you can find us in the fabric-contracts-api channel on Discord.

Here are a few guidelines to help you contribute successfully...

Issues

All issues are tracked in the issues tab in GitHub. 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.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 Discord if you're unsure which issue to choose.

Enhancements

Make sure you have the support of the Hyperledger Fabric community before investing a lot of effort in project enhancements. Please look up the Fabric RFC process for large changes.

Pull Requests

We use our own forks and Github Flow to deliver changes to the code. Follow these steps to deliver your first pull request:

  1. Fork the repository and create a new branch from main.
  2. If you've added code that should be tested, add tests!
  3. If you've added any new features or made breaking changes, update the documentation.
  4. Ensure all the tests pass.
  5. Include the JIRA issue number, a descriptive message, and the Developer Certificate of Origin (DCO) sign-off on all commit messages.
  6. Issue a pull request!
  7. GitHub Actions builds must succeed before the pull request can be reviewed and merged.

Coding Style

Please to try to be consistent with the rest of the code and conform to checkstyle rules where they are provided. Spotless is used to enforce code formatting. You can run ./gradlew spotlessApply to apply the mandated code formatting to the codebase before submitting changes to avoid failing the build with formatting violations.

Code of Conduct Guidelines

See our Code of Conduct Guidelines.

Maintainers

Should you have any questions or concerns, please reach out to one of the project's Maintainers.

How to work with the Codebase

Some useful gradle commands to help with building. You can add or remove the --no-daemon as you wish; depending on the performance of you local machine.

# build everything
./gradlew --no-daemon build

# clean up to force tests and compile to rerun
./gradlew clean cleanTest
./gradlew --no-daemon :fabric-chaincode-shim:build

# build docker image
./gradlew :fabric-chaincode-docker:buildImage

You can also scan for vulnerabilities in dependencies (requires Make and Go to be installed):

make scan

Hyperledger Fabric

See the Hyperledger Fabric contributors guide for more details, including other Hyperledger Fabric projects you may wish to contribute to.

Creative Commons License
This work is licensed under a Creative Commons Attribution 4.0 International License