...
- This limits the surface area of the change, and makes it easier to identify root causes when issues arise.
- Make sure your PR doesn't display commits that are not part of it. This may happen if your fork is not up to date.
Link to Issue
- When submitting your PR, include the issue's link in the description and number in the title (i.e.
[BESU-99] My Awesome PR), this helps provide more context on your work and auto-update the issue ticket to include a link to your PR.
Minimize
...
lines of code (LOC) per PR
- PRs get near exponentially longer to review as the number of lines of code increase. Ideally, try and keep your changes to under 300 LOC. If that is not possible, try and break up your PR into smaller ones for reviewers to review sequentially.
- One way to do this if, for some reason, the change has to all go in the codebase at once, is to have a PR open on the Besu repository linking to smaller PRs on your Besu fork.
...