The documentation is maintained using a "contributor workflow" where everyone without exception contributes changes proposals using "pull-requests".
This facilitates social contribution, easy testing, and peer review.
To contribute changes, use the following workflow:
- Fork the repository.
- Clone your fork to your computer.
- 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)._
- Make your changes adhering to the documentation 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 typo fixes with actual documentation changes.
- Commit your changes see How to Write a Git Commit Message article by Chris Beams.
- Make sure to add DCO message to each commit, more information here
- Test your changes locally before pushing to ensure that what you are proposing is not breaking another part of the doc.
- displaying the doc with MkDocs in a preview mode enables you to check the rendering as explained in the MkDocs And Markdown Guide.
- Push your changes to your remote fork (usually labeled as
origin). - Create a pull-request (PR) on the Besu doc repository. If the PR addresses an existing issue, include the issue number in the PR title in square brackets (for example,
[BESU-1234]). - Add labels to identify the type of your PR. For example, if your PR fixes a bug, add the "bug" label.
- If the PR addresses an existing issue, comment in the issue with the PR number.
- Ensure your changes are reviewed. Select the reviewers you would like to review your PR. If you don't know who to choose, simply select the reviewers proposed by GitHub or leave blank and let us know on Hyperledger Besu chat.
- Make any required changes on your contribution from the reviewers feedback. Make the changes, commit to your branch, and push to your remote fork.
- When your PR is validated, all tests passed and your branch has no conflicts with the target branch, you can "squash and merge" your PR and you're done. You contributed to Hyperledger Besu documentation! Thanks !