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.
Making Feature/Enhancement Proposals
Reporting bugs
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.
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.
- Fork BAF via Github UI
- Clone the fork to your local machine
- Complete the desired changes and where possible test locally (more detail to come here)
- Commit your changes
i) Make sure you sign your commit using git commit -s for more information see here
ii) Make sure your commit message follows Conventional Commits syntax; this aids in release notes generation - Push your changes to your feature branch
- 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 master branch)
- Await DCO & linting quality checks ( CI to come soon ), as well as any feedback from reviewers.
- Work on the feedbacks to revise the PR if there are any comments
- 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 , master branch in case of a critical defect / bug .
This work is licensed under a Creative Commons Attribution 4.0 International License.
