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: add code review guide #2772

Merged
merged 1 commit into from
May 10, 2024
Merged

docs: add code review guide #2772

merged 1 commit into from
May 10, 2024

Conversation

hairyhum
Copy link
Contributor

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:

  • 🚧 Work in Progress
  • 🌈 Refactoring (no functional changes, no api changes)
  • 🐹 Trivial/Minor
  • 🐛 Bugfix
  • 🌻 Feature
  • 🗺️ Documentation
  • 🤖 Test
  • 📖 Documentation

Test Plan

  • 💪 Manual
  • ⚡ Unit test
  • 💚 E2E

CODE_REVIEW.md Outdated Show resolved Hide resolved
CODE_REVIEW.md Outdated Show resolved Hide resolved
CODE_REVIEW.md Outdated Show resolved Hide resolved
CODE_REVIEW.md Outdated Show resolved Hide resolved
Copy link
Member

@shuguet shuguet left a comment

Choose a reason for hiding this comment

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

LGTM, thank you @hairyhum !

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
Copy link
Contributor

Choose a reason for hiding this comment

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

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.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Good point. Added to contributors guide and mentioned here.

Copy link
Contributor

@viveksinghggits viveksinghggits left a comment

Choose a reason for hiding this comment

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

LGTM

@hairyhum hairyhum mentioned this pull request Mar 22, 2024
61 tasks
@hairyhum hairyhum force-pushed the reno-changelog branch 2 times, most recently from 81ff51e to 829dd7c Compare April 10, 2024 15:39
Copy link
Contributor

@viveksinghggits viveksinghggits left a comment

Choose a reason for hiding this comment

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

It looks like we are missing new lines at the end of some of the files. otherwise looks good.

@hairyhum hairyhum merged commit ec97281 into reno-changelog May 10, 2024
5 of 6 checks passed
@hairyhum hairyhum deleted the review-guide branch May 10, 2024 16:14
hairyhum added a commit that referenced this pull request May 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

3 participants