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

docs(contributing): clarify pull request review guidelines #13546

Merged
merged 1 commit into from
Jan 14, 2022

Conversation

HonkingGoose
Copy link
Collaborator

Changes:

  • Explain how to apply reviewer suggested changes (and how to batch them, to reduce noise!)
  • Explain how to resolve a review comment (instead of commenting "done")
  • Link to relevant GitHub Docs for both concepts

Context:

As asked for by @viceice in #13463 (comment):

So we only need some sentence about to suppress short comments like Done and instead resolve conversation.

I see that contributors sometimes do not use the maintainer provided code suggestions. It might be good to mention the "apply changes" workflow here as well, to nudge people into using the suggestion as-is, instead of duplicating the work, and then commenting "done", and leaving us to manually resolve the related items.

Documentation (please check one with an [x])

  • I have updated the documentation, or
  • No documentation update is required

How I've tested my work (please tick one)

I have verified these changes via:

  • Code inspection only, or
  • Newly added/modified unit tests, or
  • No unit tests but ran on a real repository, or
  • Both unit tests + ran on a real repository

@rarkins rarkins merged commit fd51526 into renovatebot:main Jan 14, 2022
@HonkingGoose HonkingGoose deleted the patch-1 branch January 14, 2022 09:17
@renovate-release
Copy link
Collaborator

🎉 This PR is included in version 31.25.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Feb 14, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants