Thanks for taking the time to contribute!
Welcome to the Besu repository! The following links are a set of guidelines for contributing to this repo and its packages. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.
Contributions come in the form of code submissions, writing documentation, raising issues, helping others in chat, and any other actions that help develop Besu.
LF / Jira Accounts
Having the following accounts is necessary for contributing code/issues to Besu.
- If you want to contribute code, you can make a Linux Foundation (LF) account here.
- If you want to raise an issue, you can login to your Atlassian account here.
- Our Rocket Chat also requires a Linux Foundation (LF) account.
Useful contributing links
...
...
...
...
...
...
...
...
...
...
Welcome!
Assuming you've already read the Code of Conduct, read on.
Please join our Discord - it's the best place to ask if you have any questions.
To start developing with Besu, you'll want to know how to build from source and be familiar with coding conventions, and how to run the tests locally.
There’s a few different ways to build and run Besu https://besu.hyperledger.org/public-networks/get-started/install
since The Merge, you need to run besu with a CL - see https://besu.hyperledger.org/public-networks/tutorials/besu-teku-mainnet - checkpoint sync is pretty quick
Note that doing a full sync will take days and take up TB of disk space. Checkpoint is a good option if testing locally. Some info on resource requirements https://besu.hyperledger.org/public-networks/get-started/system-requirements
Ready to contribute? Yay!