Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

01: add tips to minimise review burden #64

Merged
merged 1 commit into from
Jan 19, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions contributing.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -27,3 +27,11 @@ When writing commit messages be sure to have read Chris Beams' "How to Write a G
As described in CONTRIBUTING.md, PRs should be prefixed with the component or area the PR affects.
Common areas are listed in CONTRIBUTING.md section: https://github.com/bitcoin/bitcoin/tree/master/CONTRIBUTING.md#creating-the-pull-request[Creating the pull request^].
Individual commit messages are also often given similar prefixes in the commit title depending on which area of the codebase the changes primarily affect.

[TIP]
====
Unless there is a merge conflict (usually detected by DrahtBot), don't rebase your changes on master branch before pushing.
If you avoid rebases on upstream, Github will show a very useful "Compare" button which reviewers can often use to quickly re-ACK the new changes if they are sufficiently small.
If you _do_ rebase this button becomes useless, as all the rebased changes from master get included and so a full re-review may be needed.
Developer review time is currently our major bottleneck in the project!
====
Loading