add reviewer guideline #2507

kmrmt · 2024-05-27T12:22:11Z

Description

add guideline for reviewers

Related Issue

Versions

Go Version: 1.22.3
Rust Version: 1.77.2
Docker Version: 20.10.8
Kubernetes Version: v1.30.0
NGT Version: 2.2.1

Checklist

I have read the CONTRIBUTING document and completed our CLA agreement.
I have checked open Pull Requests for the similar feature or fixes?

Special notes for your reviewer

Summary by CodeRabbit

Documentation
- Added a comprehensive reviewer guideline for Pull Requests in the Vald project. This document covers preparation, review requests, approval conditions, reviewer responsibilities, communication methods, and effect measurement to optimize the review process and ensure quality control.

Signed-off-by: Kosuke Morimoto <[email protected]>

coderabbitai · 2024-05-27T12:22:17Z

Walkthrough

The reviewer-guideline.md file has been introduced to the Vald project documentation. This file provides a comprehensive set of guidelines for reviewing Pull Requests (PRs), including preparation, review requests, approval conditions, reviewer responsibilities, communication methods, and effect measurement. The goal is to streamline the PR review process and ensure high-quality code contributions.

Changes

File Path	Change Summary
`docs/contributing/reviewer-guideline.md`	Added a detailed guideline for reviewing PRs, focusing on preparation, review requests, approval conditions, reviewer responsibilities, communication methods, and effect measurement. No changes to exported or public entities.

Tip

Early Access Features

gpt-4o model for chat

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai generate interesting stats about this repository and render them as a table.
- @coderabbitai show all the console.log statements in this repository.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to full the review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

vdaas-ci · 2024-05-27T12:22:22Z

[CHATOPS:HELP] ChatOps commands.

🙆‍♀️ /approve - approve
🍱 /format - format codes and add licenses
✅ /gen-test - generate test codes
🏷️ /label - add labels
🔚 2️⃣ 🔚 /label actions/e2e-deploy - run E2E deploy & integration test

docs/contributing/reviewer-guideline.md

github-actions · 2024-05-27T12:23:52Z

docs/contributing/reviewer-guideline.md

+
+The purpose of this guideline is to clarify what reviewers should be aware of and to optimize communication, thereby facilitating efficient development of Vald.
+
+## Preperation


🚫 [documents testlint] <eslint.rules.en-spell> _{reported by reviewdog 🐶}
Preperation => Preparation (en-spell)

docs/contributing/reviewer-guideline.md

github-actions · 2024-05-27T12:23:53Z

docs/contributing/reviewer-guideline.md

+The following criteria often determine the choice of communication tool:
+
+- On GitHub Mainly used for specific questions or comments about the code. If the exchange is unsuitable for comments, use Slack or Zoom.
+- On Slack Used for brief exchanges. If the discussion is likely to be lengthy or complex, switch to Zoom.


🚫 [documents testlint] <eslint.rules.write-good> _{reported by reviewdog 🐶}
"likely" can weaken meaning (write-good)

docs/contributing/reviewer-guideline.md

This commit fixes the style issues introduced in 97aa0a6 according to the output from Gofumpt and Prettier. Details: #2507

cloudflare-workers-and-pages · 2024-05-27T12:24:41Z

Deploying vald with Cloudflare Pages

Latest commit:	`f00adf5`
Status:	✅ Deploy successful!
Preview URL:	https://38f1f577.vald.pages.dev
Branch Preview URL:	https://documentation-contributing-r.vald.pages.dev

View logs

coderabbitai

Actionable comments posted: 5

Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 529e3d0 and 97aa0a6.

Files selected for processing (1)

docs/contributing/reviewer-guideline.md (1 hunks)

Additional Context Used

LanguageTool (1)

docs/contributing/reviewer-guideline.md (1)

Near line 72: Possible missing comma found.
Context: ...e for comments, use Slack or Zoom. - On Slack Used for brief exchanges. If the discus...
Rule ID: AI_HYDRA_LEO_MISSING_COMMA

Markdownlint (3)

docs/contributing/reviewer-guideline.md (3)

50: Expected: h3; Actual: h4
Heading levels should only increment by one level at a time

79: null
Bare URL used

81: null
Files should end with a single newline character

docs/contributing/reviewer-guideline.md

coderabbitai

Actionable comments posted: 3

Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 97aa0a6 and 706e333.

Files selected for processing (1)

docs/contributing/reviewer-guideline.md (1 hunks)

Additional Context Used

LanguageTool (2)

docs/contributing/reviewer-guideline.md (2)

Near line 71: Possible missing comma found.
Context: ...the choice of communication tool: - On GitHub Mainly used for specific questions or c...
Rule ID: AI_HYDRA_LEO_MISSING_COMMA

Near line 72: Possible missing comma found.
Context: ...e for comments, use Slack or Zoom. - On Slack Used for brief exchanges. If the discus...
Rule ID: AI_HYDRA_LEO_MISSING_COMMA

Markdownlint (2)

docs/contributing/reviewer-guideline.md (2)

50: Expected: h3; Actual: h4
Heading levels should only increment by one level at a time

79: null
Bare URL used

Additional comments not posted (1)

docs/contributing/reviewer-guideline.md (1)
50-50: Correct the heading level to maintain proper structure.
- #### What Reviewers Should Do
+ ### What Reviewers Should Do
Likely invalid or redundant comment.

docs/contributing/reviewer-guideline.md

Signed-off-by: Kosuke Morimoto <[email protected]>

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> Signed-off-by: Kosuke Morimoto <[email protected]>

coderabbitai

Actionable comments posted: 6

Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 706e333 and 248c4d8.

Files selected for processing (1)

docs/contributing/reviewer-guideline.md (1 hunks)

Additional Context Used

LanguageTool (1)

docs/contributing/reviewer-guideline.md (1)

Near line 72: Possible missing comma found.
Context: ...e for comments, use Slack or Zoom. - On Slack Used for brief exchanges. If the discus...
Rule ID: AI_HYDRA_LEO_MISSING_COMMA

Markdownlint (1)

docs/contributing/reviewer-guideline.md (1)

79: null
Bare URL used

docs/contributing/reviewer-guideline.md

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> Signed-off-by: Kosuke Morimoto <[email protected]>

Signed-off-by: Kosuke Morimoto <[email protected]>

docs/contributing/reviewer-guideline.md

Signed-off-by: Kosuke Morimoto <[email protected]>

docs/contributing/reviewer-guideline.md

Signed-off-by: Kosuke Morimoto <[email protected]>

kmrmt · 2024-05-28T11:27:10Z

@coderabbitai review

coderabbitai · 2024-05-28T11:27:15Z

Actions Performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

coderabbitai

Actionable comments posted: 0

Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 248c4d8 and f00adf5.

Files selected for processing (1)

docs/contributing/reviewer-guideline.md (1 hunks)

Files skipped from review as they are similar to previous changes (1)

docs/contributing/reviewer-guideline.md

kmrmt · 2024-05-28T11:30:02Z

@coderabbitai review

coderabbitai · 2024-05-28T11:30:54Z

Actions Performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

kmrmt · 2024-05-28T12:02:46Z

@coderabbitai review

coderabbitai · 2024-05-28T12:02:50Z

Actions Performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

* add reviewer guideline Signed-off-by: Kosuke Morimoto <[email protected]> * style: format code with Gofumpt and Prettier This commit fixes the style issues introduced in 97aa0a6 according to the output from Gofumpt and Prettier. Details: #2507 * fix typo Signed-off-by: Kosuke Morimoto <[email protected]> * Apply suggestions from code review Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> Signed-off-by: Kosuke Morimoto <[email protected]> * Apply suggestions from code review Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> Signed-off-by: Kosuke Morimoto <[email protected]> * fix Signed-off-by: Kosuke Morimoto <[email protected]> * fix Signed-off-by: Kosuke Morimoto <[email protected]> * fix review request Signed-off-by: Kosuke Morimoto <[email protected]> --------- Signed-off-by: Kosuke Morimoto <[email protected]> Signed-off-by: Kosuke Morimoto <[email protected]> Co-authored-by: deepsource-autofix[bot] <62050782+deepsource-autofix[bot]@users.noreply.github.com> Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

* add reviewer guideline * style: format code with Gofumpt and Prettier This commit fixes the style issues introduced in 97aa0a6 according to the output from Gofumpt and Prettier. Details: #2507 * fix typo * Apply suggestions from code review * Apply suggestions from code review * fix * fix * fix review request --------- Signed-off-by: Kosuke Morimoto <[email protected]> Signed-off-by: Kosuke Morimoto <[email protected]> Co-authored-by: Kosuke Morimoto <[email protected]> Co-authored-by: deepsource-autofix[bot] <62050782+deepsource-autofix[bot]@users.noreply.github.com> Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

fix: git add chart directory for release (#2356) (#2357) [patch] release v1.7.11 (#2358) :bookmark: :robot: Release v1.7.11 (#2360) Change docker scan timeout longer (#2363) (#2364) refactor code using golangci-lint (#2362) (#2365) Create SECURITY.md (#2367) (#2368) add commit hash build image (#2359) (#2371) update docker build target platform selection rules (#2370) (#2374) Make agent export index metrics to Pod k8s resource (#2319) (#2372) backport ci deps others (#2386) Update workflow to release readreplica chart (#2383) (#2387) :green_heart: :recycle: Add Con-Bench helm chart to the Vald charts (#2388) (#2389) Delete unnecessary code for mirror (#2366) (#2391) change JP logo to EN logo (#2369) (#2392) Add rotate-all option to rotator (#2305) (#2393) fix: build error of internal kvs test (#2396) (#2398) Resolve kvs already closed before last saving (#2390) (#2394) :robot: Update license headers / Format Go codes and YAML files (#2397) (#2400) create continous benchmark doc (#2352) (#2395) fix: disable protobuf dispatch for client (#2401) (#2403) update deps (#2404) (#2405) [patch] release v1.7.12 (#2406) :bookmark: :robot: Release v1.7.12 (#2408) :pencil: Fix typo of file name (#2413) (#2415) Fix agent-faiss build failed (#2418) (#2419) Add tests for index information export (#2412) (#2414) Fix the logic to determine docker image (#2410) (#2420) Update build rule for nightly image (#2421) (#2422) Fix output settings to determine-docker-image-tag action and release branch build tag name (#2423) (#2425) Add `index-operator` template implementation (#2375) (#2424) fix: typo of execution rule (#2426) (#2427) Backport Flush API (#2434) update deps & add validation for Flush API when agent is Read Only (#2433) (#2436) docs: add hrichiksite as a contributor for doc (#2441) (#2442) fix: bugfix version update for docker build (#2445) (#2446) Fix index job logic to pass DNS A record (#2438) (#2448) Added snapshot timestamp annotations to read replica agent (#2428) (#2443) Fix operator-sdk version (#2447) (#2449) add file name lint (#2417) (#2450) fix: add extra option for ci-container build (#2451) (#2452) Add base of benchmark operator dashboard (#2430) (#2453) Implement index operator logic for read replica rotation (#2444) (#2456) add inner product distance type for ngt (#2454) (#2458) Fix e2e for read replica and add e2e for index operator (#2455) (#2459) Add unit tests for index operator (#2460) (#2461) Bugfix recreate benchmark job when operator reboot (#2463) (#2464) Refactor k8s types (#2462) (#2465) :robot: Automatically update PULL_REQUEST_TEMPLATE and ISSUE_TEMPLATE (#2457) (#2469) Fix workflow trigger for backport pr creation (#2471) (#2472) Automatically add backport main label for release-pr (#2473) (#2475) update deps (#2468) (#2476) Implement client metrics interceptor for continuous benchmark job (#2477) (#2480) :chart_with_upwards_trend: Add client metrics panels for continuous benchmark job (#2481) (#2483) Update continuous benchmark docs (#2485) (#2486) Sync release/v1.7 to main (#2495) add read replica and rotator docs (#2497) (#2499) add reviewer guideline (#2507) (#2508) update large top-K ratio handling logic (#2509) (#2511) Change default image tag from latest to nightly (#2516) (#2518) Bugfix that caused an error when argument has 3 or more nil arguments (#2517) (#2520) add faiss in values.yaml & valdrelease.yaml (#2514) (#2519) capitalize faq (#2512) (#2522) Backport docs updates to release/v1.7 (#2521) [CI] Add workflow to synchronize ubuntu base image (#2526) (#2527) fix: update schedule (#2528) (#2530) refactor index manager service add index service API to expose index informations (#2525) (#2532) fix conflict bug (#2537) fix: make format (#2534) (#2540) Backport PR #2542, #2538 to release/v1.7 (#2543) fix: add checkout option (#2545) (#2546) Implement ngt Statistics API (#2539) (#2547) Add workflow to check git conflict for backport PR (#2548) (#2550) [create-pull-request] automated change (#2552) (#2556) Update dependencies, C++ standard, and improve Dockerfiles for better build systems and localization (#2549) (#2557) Backport #2559 (#2560) [BUGFIX] index correction process (#2565) (#2566) change external docker image reference to ghcr.io registry (#2567) (#2568) [patch] Release v1.7.13 (#2569) :bookmark: :robot: Release v1.7.13 (#2570) add HTTP2 support for http.Client and Vald HTTP Server (#2572) (#2575) Signed-off-by: kpango <[email protected]>

add reviewer guideline

97aa0a6

Signed-off-by: Kosuke Morimoto <[email protected]>

github-actions bot added size/M type/documentation priority/low labels May 27, 2024

github-actions bot reviewed May 27, 2024

View reviewed changes

docs/contributing/reviewer-guideline.md Outdated Show resolved Hide resolved

docs/contributing/reviewer-guideline.md Outdated Show resolved Hide resolved

github-actions bot reviewed May 27, 2024

View reviewed changes

style: format code with Gofumpt and Prettier

706e333

This commit fixes the style issues introduced in 97aa0a6 according to the output from Gofumpt and Prettier. Details: #2507

coderabbitai bot requested changes May 27, 2024

View reviewed changes

docs/contributing/reviewer-guideline.md Outdated Show resolved Hide resolved

docs/contributing/reviewer-guideline.md Outdated Show resolved Hide resolved

github-actions bot reviewed May 27, 2024

View reviewed changes

docs/contributing/reviewer-guideline.md Show resolved Hide resolved

docs/contributing/reviewer-guideline.md Show resolved Hide resolved

coderabbitai bot requested changes May 27, 2024

View reviewed changes

docs/contributing/reviewer-guideline.md Outdated Show resolved Hide resolved

docs/contributing/reviewer-guideline.md Show resolved Hide resolved

kmrmt and others added 2 commits May 27, 2024 21:38

fix typo

248c4d8

Signed-off-by: Kosuke Morimoto <[email protected]>

Apply suggestions from code review

f0cf63f

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> Signed-off-by: Kosuke Morimoto <[email protected]>

coderabbitai bot requested changes May 27, 2024

View reviewed changes

github-actions bot reviewed May 27, 2024

View reviewed changes

docs/contributing/reviewer-guideline.md Show resolved Hide resolved

kmrmt and others added 2 commits May 27, 2024 21:46

Apply suggestions from code review

bda9810

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> Signed-off-by: Kosuke Morimoto <[email protected]>

fix

36fb58f

Signed-off-by: Kosuke Morimoto <[email protected]>

github-actions bot reviewed May 27, 2024

View reviewed changes

docs/contributing/reviewer-guideline.md Outdated Show resolved Hide resolved

docs/contributing/reviewer-guideline.md Show resolved Hide resolved

docs/contributing/reviewer-guideline.md Outdated Show resolved Hide resolved

fix

9026918

Signed-off-by: Kosuke Morimoto <[email protected]>

github-actions bot reviewed May 27, 2024

View reviewed changes

docs/contributing/reviewer-guideline.md Outdated Show resolved Hide resolved

github-actions bot reviewed May 27, 2024

View reviewed changes

docs/contributing/reviewer-guideline.md Outdated Show resolved Hide resolved

kmrmt requested review from a team, kpango and hlts2 and removed request for a team May 27, 2024 12:57

kmrmt added the actions/backport/release/v1.7 label May 27, 2024

kmrmt changed the title ~~add reviewer guideline~~ [WIP] add reviewer guideline May 28, 2024

kmrmt marked this pull request as draft May 28, 2024 00:56

fix review request

f00adf5

Signed-off-by: Kosuke Morimoto <[email protected]>

kmrmt changed the title ~~[WIP] add reviewer guideline~~ add reviewer guideline May 28, 2024

coderabbitai bot reviewed May 28, 2024

View reviewed changes

kmrmt marked this pull request as ready for review May 28, 2024 11:58

kmrmt requested review from a team, kpango and datelier and removed request for a team May 29, 2024 01:13

datelier approved these changes May 29, 2024

View reviewed changes

coderabbitai bot approved these changes May 29, 2024

View reviewed changes

kpango approved these changes May 30, 2024

View reviewed changes

kmrmt merged commit 70c933c into main May 30, 2024
21 checks passed

kmrmt deleted the documentation/contributing/reviewer-guideline branch May 30, 2024 11:22

github-actions bot mentioned this pull request Jun 1, 2024

Monthly review time metrics report: 2024-05-01..2024-05-31 #2510

Closed

This was referenced Aug 1, 2024

[patch] Release v1.7.3 #2558

Closed

[patch] Release v1.7.13 #2561

Closed

[patch] Release v1.7.13 #2562

Closed

[patch] Release v1.7.13 #2569

Merged

coderabbitai bot mentioned this pull request Sep 26, 2024

Implement deadlink checker for vald web #2643

Merged

2 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

add reviewer guideline #2507

add reviewer guideline #2507

kmrmt commented May 27, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented May 27, 2024 •

edited

Loading

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (`.coderabbit.yaml`)

Documentation and Community

vdaas-ci commented May 27, 2024

github-actions bot May 27, 2024

github-actions bot May 27, 2024

cloudflare-workers-and-pages bot commented May 27, 2024 •

edited

Loading

coderabbitai bot left a comment

coderabbitai bot left a comment

coderabbitai bot left a comment

kmrmt commented May 28, 2024

coderabbitai bot commented May 28, 2024

coderabbitai bot left a comment

kmrmt commented May 28, 2024

coderabbitai bot commented May 28, 2024

kmrmt commented May 28, 2024

coderabbitai bot commented May 28, 2024


		The purpose of this guideline is to clarify what reviewers should be aware of and to optimize communication, thereby facilitating efficient development of Vald.

		## Preperation

add reviewer guideline #2507

add reviewer guideline #2507

Conversation

kmrmt commented May 27, 2024 • edited by coderabbitai bot Loading

Description

Related Issue

Versions

Checklist

Special notes for your reviewer

Summary by CodeRabbit

coderabbitai bot commented May 27, 2024 • edited Loading

Walkthrough

Changes

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (.coderabbit.yaml)

Documentation and Community

vdaas-ci commented May 27, 2024

github-actions bot May 27, 2024

Choose a reason for hiding this comment

github-actions bot May 27, 2024

Choose a reason for hiding this comment

cloudflare-workers-and-pages bot commented May 27, 2024 • edited Loading

Deploying vald with Cloudflare Pages

coderabbitai bot left a comment

Choose a reason for hiding this comment

coderabbitai bot left a comment

Choose a reason for hiding this comment

coderabbitai bot left a comment

Choose a reason for hiding this comment

kmrmt commented May 28, 2024

coderabbitai bot commented May 28, 2024

coderabbitai bot left a comment

Choose a reason for hiding this comment

kmrmt commented May 28, 2024

coderabbitai bot commented May 28, 2024

kmrmt commented May 28, 2024

coderabbitai bot commented May 28, 2024

kmrmt commented May 27, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented May 27, 2024 •

edited

Loading

CodeRabbit Configration File (`.coderabbit.yaml`)

cloudflare-workers-and-pages bot commented May 27, 2024 •

edited

Loading