Skip to content

Latest commit

 

History

History
59 lines (43 loc) · 3.91 KB

CONTRIBUTING.md

File metadata and controls

59 lines (43 loc) · 3.91 KB
Raw

Contributing

Thank you for your interest to contribute to BAF!

We welcome contributions to the Blockchain Automation Framework Project in many forms, and there's always plenty to do!

First things first, please review the Hyperledger Code of Conduct before participating and please follow it in all your interactions with the project.

You can contibute to BAF, as a user or/and as a developer.

As a user:

Making Feature/Enhancement Proposals
Reporting bugs

As a developer:

Consider picking up a “help-wanted” or "good-first-issue" task

If you can commit to full-time/part-time development, then please contact us on our Rocketchat channel to work through logistics!

Please visit the Developer Guide in the docs to learn how to make contributions to this exciting project.

Pull Request Process :

For source code integrity , Blockchain Automation Framework GitHub pull requests are accepted from forked repositories only. There are also quality standards identified and documented here that will be enhanced over time.

  1. Fork BAF via Github UI.
  2. Clone the fork to your local machine.
  3. Complete the desired changes and where possible test locally:
    • Go to platforms/shared/configuration directory
    • Execute molecule test --all
    • Go to your changed platform directory like platforms/r3-corda/configuration (use respective platform directories)
    • Execute molecule test --all
  4. Commit your changes
    • Make sure you sign your commit using git commit -s for more information see here.
    • Squash all commits to a single commit.
    • Make sure your commit message follows Conventional Commits syntax and contains the platform changed:
      • [corda] for Corda Opensource changes
      • [corda-ent] for Corda Enterprise changes
      • [fabric] for Hyperledger Fabric changes
      • [besu] for Hyperledger Besu changes
      • [indy] for Hyperledger Indy changes
      • [quorum] for Quorum changes
      • [shared] for all common and other changes
  5. Push your changes to your feature branch.
  6. Initiate a pull request from your fork to the base repository ( develop branch , unless it is a critical bug, in that case initiate to the main branch)
  7. Await DCO & linting quality checks and GitActions to complete, as well as any feedback from reviewers.
  8. Work on the feedbacks to revise the PR if there are any comments
  9. If not, the PR gets approved , delete feature branch post the merge

NOTE: If you are a regular contributor , please make sure to take the latest pull from the develop branch everytime before making any pull request , main branch in case of a critical defect / bug .

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