Skip to content

Update CONTRIBUTING with more clear review feedback handling #1296

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
christos68k merged 2 commits into from
Apr 1, 2026
Merged

Update CONTRIBUTING with more clear review feedback handling #1296

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d28e106
Update CONTRIBUTING with more clear review feedback handling
christos68k Mar 27, 2026
f52217e
Minor update
christos68k Mar 27, 2026
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
19 changes: 19 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,25 @@ All pull requests are squashed to a single commit upon merge to `main`.
[`draft`](https://github.blog/2019-02-14-introducing-draft-pull-requests/).
* Make sure CLA is signed and CI is clear.

### How to Address Review Feedback

Please use the GitHub UI to accept review suggestions that you don't
subsequently modify. Do not reimplement them in a separate commit.
The latter behavior is problematic as it:

1. Increases burden on reviewers who have to spend additional time to check
that your reimplementation accurately reflects the original suggestion.
2. Increases the probability of bugs being introduced into the codebase.
This is not a theoretical concern as we've seen it happen multiple times.
3. Does not credit the reviewer who came up with the accepted suggestion.

You can pull the GitHub-generated commits (after you've accepted a suggestion)
into your local repository by executing:

@florianl florianl Apr 1, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

To me this guide promotes reviewers to ask for a rephrase of a comment to get credit on the whole PR.
Reviewers, that comment and point out structual issues and request such changes will not get credit for it.

@christos68k christos68k Apr 1, 2026 •
edited
Loading

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The credit will come automatically from GH if the author accepts a suggestion. I'm not opposed to having an additional mechanism for credit related to deeper structural changes that are also accepted, that sounds good to me.

We should open another PR for that.

```sh
git pull <YOUR_FORK> <YOUR_BRANCH_NAME>
```

### How to Get PRs Merged

A PR is considered **ready to merge** when:
Expand Down
Loading