Besu : First contribution

Created by Felipe Faraggi, last modified by Sally MacFarlane on Sep 15, 2024

Accounts

Having the following accounts is necessary for contributing code/issues to Besu.

  • If you want to raise an issue or contribute code or documentation, you will need a GitHub account.
  • Our Discord also requires a Discord login.
  • If you want to contribute to this wiki, you can make a Linux Foundation (LF) account here.

Where to start?

The first step is deciding what to work on! We use the "good first issue" label to identify issues that we think are a good place to start.

If you find an issue that you'd like to work on, reach out on Discord and we can assign the issue to you. 

If you have a different idea, reach out on Discord in the #besu channel and we can discuss!

Once the issue is assigned to you, follow the workflow below.

Contribution Workflow

The codebase and documentation are maintained using the same "contributor workflow" where everyone without exception contributes changes proposals using PRs or "pull-requests".

This facilitates social contribution, easy testing, and peer review.

To contribute changes, use the following workflow:

  1. Fork the repository. Make sure you also add an upstream to be able to update your fork.
  2. Clone your fork to your computer.
  3. Create a topic branch and name it appropriately. Starting the branch name with the issue number is a good practice and a reminder to fix only one issue in a Pull-Request (PR).
  4. Make your changes adhering to the coding conventions described below.  In general a commit serves a single purpose and diffs should be easily comprehensible. For this reason do not mix any formatting fixes or code moves with actual code changes.
  5. Commit your changes  see How to Write a Git Commit Message article by Chris Beams.
    1. Make sure to add DCO message to each commit (for example in the command line: git commit -s -m "..."), more information here
  6. Test your changes locally before pushing to ensure that what you are proposing is not breaking another part of the software. Running the ./gradlew clean check test command locally will help you to be confident that your changes will pass CI tests once pushed as a Pull Request.
  7. Push your changes to your remote fork (usually labeled as  origin).
  8. Create a pull-request (PR) on the Besu repository. If it's not ready to review, make it a `Draft` PR. If the PR addresses an existing issue, include the issue number in the PR title in square brackets (for example,  [#2374]).
  9. Add labels to identify the type of your PR.  For example, if your PR fixes a bug, add the "bug" label.
  10. If the PR address an existing issue, comment in the issue with the PR number.
  11. Ensure your changes are reviewed. Let us know using Besu chat channels that your PR is ready for review. If you are a maintainer, you can choose reviewers, otherwise this will be done by one of the maintainers.
  12. Make any required changes on your contribution from the reviewers feedback.  Make the changes, commit to your branch, and push to your remote fork.
  13. When your PR is approved, validated, all tests pass and your branch has no conflicts, it can be merged. Again, this action needs to be done by a maintainer - usually the same person who approves will also merge it.


You contributed to Besu! Thanks!