docs: add code review guide #2772
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
shuguet
reviewed
Mar 20, 2024
shuguet
reviewed
Mar 20, 2024
shuguet
reviewed
Mar 20, 2024
shuguet
reviewed
Mar 20, 2024
shuguet
approved these changes
Mar 21, 2024
CODE_REVIEW.md
Outdated
| - If PR changes documented behaviour, there should be update to `/docs` or inline comments | ||
| - Reviewer should request changes from contributor to update docs | ||
| - If PR introduces breaking changes, fixes a bug or adds a new feature, there should be a [release note](#release-notes) | ||
| - Reviewer may add a release note by themself |
There was a problem hiding this comment.
I think we should clarify, whose responsibility it is to add the release note. I think it's PR author's responsibility. if we not explicitly set the expectation here, one would think the other is going to do that.
There was a problem hiding this comment.
Good point. Added to contributors guide and mentioned here.
hairyhum
force-pushed
the
reno-changelog
branch
2 times, most recently
from
81ff51e
to
829dd7c
Compare
viveksinghggits
approved these changes
Apr 11, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Change Overview
Added new document with instructions on reviewing the PRs.
This guide mentions RENO release note tools from #2604
Pull request type
Please check the type of change your PR introduces:
Test Plan