Skip to content

CONTRIBUTING: offer clearer guidelines about blocker vs. non-blocker issues #264651

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.

Sign up for GitHub

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

Merged
fricklerhandwerk merged 2 commits into from
Sep 16, 2024
Merged

CONTRIBUTING: offer clearer guidelines about blocker vs. non-blocker issues #264651

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b57ed74
CONTRIBUTING: offer clearer guidelines about blocker vs. non-blocker …
RaitoBezarius Oct 31, 2023
0383130
reword for clarity
fricklerhandwerk Jun 4, 2024
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
6 changes: 6 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -316,6 +316,12 @@ When reviewing a pull request, please always be nice and polite. Controversial c

GitHub provides reactions as a simple and quick way to provide feedback to pull requests or any comments. The thumb-down reaction should be used with care and if possible accompanied with some explanation so the submitter has directions to improve their contribution.

When doing a review, consider focusing on the changes proposed, if you find out about anything that could be improved but is not part of the proposed changes, consider tracking it as an issue, **offer** the original contributor to do a follow-up pull request or do it in that pull request, but remember that you should ideally not make this a blocker or give the impression to the contributor this would be a blocker for this merge. If the follow-up change is structural for the contribution, make your point clear about why you feel it is important to do it before the proposed changes.

Also, consider giving to the contributor a clear representation of what you consider to be blocker and not to help them prioritize their efforts towards a potential merge.
Comment thread
fricklerhandwerk marked this conversation as resolved.
Outdated
Comment thread
fricklerhandwerk marked this conversation as resolved.
Outdated

Examples of follow-up changes can involve a cleanup in the touched files.

Pull request reviews should include a list of what has been reviewed in a comment, so other reviewers and mergers can know the state of the review.

All the review template samples provided in this section are generic and meant as examples. Their usage is optional and the reviewer is free to adapt them to their liking.
Expand Down