Backport PR #2507 to release/v1.7 for add reviewer guideline #2508

vdaas-ci · 2024-05-30T11:23:35Z

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 guideline for reviewing Pull Requests, covering preparation, review requests, approval conditions, reviewer responsibilities, communication methods, and effect measurement.

* 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>

cloudflare-workers-and-pages · 2024-05-30T11:23:37Z

Deploying vald with Cloudflare Pages

Latest commit:	`72b048b`
Status:	✅ Deploy successful!
Preview URL:	https://d7d1e16f.vald.pages.dev
Branch Preview URL:	https://backport-release-v1-7-docume-tcvj.vald.pages.dev

View logs

coderabbitai · 2024-05-30T11:23:42Z

Walkthrough

The addition of the reviewer-guideline.md file introduces a detailed set of instructions for reviewing Pull Requests in the Vald project. This document covers all aspects of the review process, including preparation, handling review requests, approval criteria, reviewer duties, communication protocols, and methods for measuring the impact of reviews.

Changes

File Path	Change Summary
`docs/contributing/reviewer-guideline.md`	Added a comprehensive guideline for reviewing Pull Requests in the Vald project.

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 do a full 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-30T11:23:47Z

[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

github-actions · 2024-05-30T11:25:15Z

docs/contributing/reviewer-guideline.md

+
+This guideline assumes that the content of the Pull Request is appropriate.
+
+Consider splitting the Pull Request if the changes are extensive, have multiple intentions, or if the tests are insufficient. This makes it easier to review.


🚫 [documents testlint] <eslint.rules.write-good> _{reported by reviewdog 🐶}
"multiple" is wordy or unneeded (write-good)

github-actions · 2024-05-30T11:25:15Z

docs/contributing/reviewer-guideline.md

+
+Consider splitting the Pull Request if the changes are extensive, have multiple intentions, or if the tests are insufficient. This makes it easier to review.
+
+Regarding the amount of change, opinions may vary, but in this project, we aim to keep the implementation of logic under 1000 lines, excluding automatically generated code such as Protocol Buffers.


🚫 [documents testlint] <eslint.rules.write-good> _{reported by reviewdog 🐶}
"Regarding" is wordy or unneeded (write-good)

github-actions · 2024-05-30T11:25:15Z

docs/contributing/reviewer-guideline.md

+
+### Request notification
+
+People may notice requests through different means, but in this project, we prioritize the following methods of communication:


🚫 [documents testlint] <eslint.rules.write-good> _{reported by reviewdog 🐶}
"prioritize" is wordy or unneeded (write-good)

github-actions · 2024-05-30T11:25:15Z

docs/contributing/reviewer-guideline.md

+
+#### When Requested for Review
+
+Unless there are high-priority issues, you are in a meeting, or deeply focused on development, start the review immediately.


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

github-actions · 2024-05-30T11:25:15Z

docs/contributing/reviewer-guideline.md

+
+- The content of the Pull Request is understood.
+- The content can be understood at a glance.
+  - If it cannot be understood at a glance, request additional comments.


🚫 [documents testlint] <eslint.rules.write-good> _{reported by reviewdog 🐶}
"additional" is wordy or unneeded (write-good)

github-actions · 2024-05-30T11:25:15Z

docs/contributing/reviewer-guideline.md

+
+### What Reviewers Should Not Do
+
+- Try to decipher something that is not immediately understandable.


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

github-actions · 2024-05-30T11:25:15Z

docs/contributing/reviewer-guideline.md

+### What Reviewers Should Not Do
+
+- Try to decipher something that is not immediately understandable.
+- Close the browser or tab or start something else if it is not understood.


🚫 [documents testlint] <eslint.rules.write-good> _{reported by reviewdog 🐶}
"it is" is wordy or unneeded (write-good)

github-actions · 2024-05-30T11:25:15Z

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)

github-actions · 2024-05-30T11:25:15Z

docs/contributing/reviewer-guideline.md

+
+Once a month, a report is created at [Vald Issues](https://github.com/vdaas/vald/issues).
+
+This report includes the time taken from when a Pull Request is opened to when it is merged and a summary of this data. Regularly reflect on this information.


🚫 [documents testlint] <eslint.rules.write-good> _{reported by reviewdog 🐶}
"it is" is wordy or unneeded (write-good)

github-actions · 2024-05-30T11:25:16Z

docs/contributing/reviewer-guideline.md

+
+Once a month, a report is created at [Vald Issues](https://github.com/vdaas/vald/issues).
+
+This report includes the time taken from when a Pull Request is opened to when it is merged and a summary of this data. Regularly reflect on this information.


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

coderabbitai

Actionable comments posted: 1

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 2514534 and 72b048b.

Files selected for processing (1)

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

Additional context used

LanguageTool

docs/contributing/reviewer-guideline.md

[uncategorized] ~71-~71: Possible missing comma found.
Context: ...the choice of communication tool: - On GitHub Mainly used for specific questions or c...

Additional comments not posted (1)

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

1-81: The document is well-structured and covers a comprehensive range of topics relevant to the review process. It is clear and provides actionable guidance for reviewers.

coderabbitai · 2024-05-30T11:27:35Z

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.


Consider adding a comma after "On GitHub" for better readability.

- On GitHub Mainly used for specific questions or comments about the code. + On GitHub, Mainly used for specific questions or comments about the code.

Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change

- On GitHub Mainly used for specific questions or comments about the code. If the exchange is unsuitable for comments, use Slack or Zoom.

- On GitHub, Mainly used for specific questions or comments about the code. If the exchange is unsuitable for comments, use Slack or Zoom.

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]>

github-actions bot added size/XXXL priority/low labels May 30, 2024

github-actions bot reviewed May 30, 2024

View reviewed changes

coderabbitai bot requested changes May 30, 2024

View reviewed changes

kmrmt merged commit e14f1e1 into release/v1.7 May 31, 2024
22 of 23 checks passed

kmrmt deleted the backport/release/v1.7/documentation/contributing/reviewer-guideline branch May 31, 2024 04:09

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

This was referenced Sep 30, 2024

Backport PR #2639 to release/v1.7 for Refctor for release v1.7.14 #2648

Merged

Backport PR #2670 to release/v1.7 for Refactor use Absolute path for Makefile #2673

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Backport PR #2507 to release/v1.7 for add reviewer guideline #2508

Backport PR #2507 to release/v1.7 for add reviewer guideline #2508

vdaas-ci commented May 30, 2024 •

edited by coderabbitai bot

Loading

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

edited

Loading

coderabbitai bot commented May 30, 2024 •

edited

Loading

Walkthrough

Changes

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (`.coderabbit.yaml`)

Documentation and Community

vdaas-ci commented May 30, 2024

github-actions bot May 30, 2024

github-actions bot May 30, 2024

github-actions bot May 30, 2024

github-actions bot May 30, 2024

github-actions bot May 30, 2024

github-actions bot May 30, 2024

github-actions bot May 30, 2024

github-actions bot May 30, 2024

github-actions bot May 30, 2024

github-actions bot May 30, 2024

coderabbitai bot left a comment

coderabbitai bot May 30, 2024


		This guideline assumes that the content of the Pull Request is appropriate.

		Consider splitting the Pull Request if the changes are extensive, have multiple intentions, or if the tests are insufficient. This makes it easier to review.


		Consider splitting the Pull Request if the changes are extensive, have multiple intentions, or if the tests are insufficient. This makes it easier to review.

		Regarding the amount of change, opinions may vary, but in this project, we aim to keep the implementation of logic under 1000 lines, excluding automatically generated code such as Protocol Buffers.


		### Request notification

		People may notice requests through different means, but in this project, we prioritize the following methods of communication:


		#### When Requested for Review

		Unless there are high-priority issues, you are in a meeting, or deeply focused on development, start the review immediately.


		### What Reviewers Should Not Do

		- Try to decipher something that is not immediately understandable.


		Once a month, a report is created at [Vald Issues](https://github.com/vdaas/vald/issues).

		This report includes the time taken from when a Pull Request is opened to when it is merged and a summary of this data. Regularly reflect on this information.


		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 GitHub Mainly used for specific questions or comments about the code. If the exchange is unsuitable for comments, use Slack or Zoom.
	- On GitHub, Mainly used for specific questions or comments about the code. If the exchange is unsuitable for comments, use Slack or Zoom.

Backport PR #2507 to release/v1.7 for add reviewer guideline #2508

Backport PR #2507 to release/v1.7 for add reviewer guideline #2508

Conversation

vdaas-ci commented May 30, 2024 • edited by coderabbitai bot Loading

Description

Related Issue

Versions

Checklist

Special notes for your reviewer

Summary by CodeRabbit

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

Deploying vald with Cloudflare Pages

coderabbitai bot commented May 30, 2024 • edited Loading

Walkthrough

Changes

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (.coderabbit.yaml)

Documentation and Community

vdaas-ci commented May 30, 2024

github-actions bot May 30, 2024

Choose a reason for hiding this comment

github-actions bot May 30, 2024

Choose a reason for hiding this comment

github-actions bot May 30, 2024

Choose a reason for hiding this comment

github-actions bot May 30, 2024

Choose a reason for hiding this comment

github-actions bot May 30, 2024

Choose a reason for hiding this comment

github-actions bot May 30, 2024

Choose a reason for hiding this comment

github-actions bot May 30, 2024

Choose a reason for hiding this comment

github-actions bot May 30, 2024

Choose a reason for hiding this comment

github-actions bot May 30, 2024

Choose a reason for hiding this comment

github-actions bot May 30, 2024

Choose a reason for hiding this comment

coderabbitai bot left a comment

Choose a reason for hiding this comment

coderabbitai bot May 30, 2024

Choose a reason for hiding this comment

vdaas-ci commented May 30, 2024 •

edited by coderabbitai bot

Loading

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

edited

Loading

coderabbitai bot commented May 30, 2024 •

edited

Loading

CodeRabbit Configration File (`.coderabbit.yaml`)