Skip to content

[GRPC] Add guide for "Contributing to gRPC"#20474

Merged
karenyrx merged 1 commit intoopensearch-project:mainfrom
karenyrx:cguide
Feb 1, 2026
Merged

[GRPC] Add guide for "Contributing to gRPC"#20474
karenyrx merged 1 commit intoopensearch-project:mainfrom
karenyrx:cguide

Conversation

@karenyrx
Copy link
Copy Markdown
Contributor

@karenyrx karenyrx commented Jan 26, 2026 •
edited
Loading

Description

As developers are looking for ways to contribte their own gRPC APIs / help expand API coverage, add a contributing guide outlining the e2e flow from spec -> protobufs -> core -> documentation.

Related Issues

Resolves #[Issue number to be closed when this PR is merged]

Check List

  • Functionality includes testing.
  • API changes companion pull request created, if applicable.
  • Public documentation issue/PR created, if applicable.

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Jan 26, 2026 •
edited
Loading

Important

Review skipped

Auto incremental reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

  • 🔍 Trigger a full review
📝 Walkthrough

Walkthrough

Documentation updates were added across the transport-grpc module to guide contributors on contributing to gRPC APIs. The main README was restructured with a comprehensive contributing guide including workflows and step-by-step instructions. The SPI README was updated with a table of contents and documentation headings. A changelog entry was added documenting these updates.

Changes

Cohort / File(s) Summary
Documentation Updates
CHANGELOG.md, modules/transport-grpc/README.md, modules/transport-grpc/spi/README.md		 Added comprehensive contributing guide documentation for gRPC APIs. Main README restructured with Table of Contents, Contributing to gRPC APIs section, and expanded Development Guide subsections covering GRPC Settings, testing, and examples. SPI README updated with Table of Contents and corrected GrpcServiceFactory documentation heading. Changelog entry added for new contributing guide.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and specifically describes the main change: adding a guide for contributing to gRPC APIs, which aligns with the changeset that adds comprehensive contributing documentation across three README files.
Description check ✅ Passed The description includes a clear explanation of the change (adding a contributing guide for gRPC with e2e flow documentation), but the Related Issues section is incomplete with a placeholder, and all checklist items are unchecked without explanation.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

Comment @coderabbitai help to get the list of available commands and usage tips.

@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Jan 26, 2026

✅ Gradle check result for fe4380e: SUCCESS

@codecov
Copy link
Copy Markdown

codecov bot commented Jan 26, 2026 •
edited
Loading

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 73.18%. Comparing base (672039d) to head (aebe16c).
⚠️ Report is 20 commits behind head on main.

Additional details and impacted files 
@@             Coverage Diff              @@
##               main   #20474      +/-   ##
============================================
- Coverage     73.25%   73.18%   -0.07%     
+ Complexity    71979    71909      -70     
============================================
  Files          5796     5796              
  Lines        329287   329287              
  Branches      47419    47419              
============================================
- Hits         241203   240992     -211     
- Misses        68759    68977     +218     
+ Partials      19325    19318       -7

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@karenyrx karenyrx marked this pull request as ready for review January 27, 2026 19:40
@karenyrx karenyrx requested a review from a team as a code owner January 27, 2026 19:40
sandeshkr419
sandeshkr419 reviewed Jan 27, 2026
View reviewed changes
@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Jan 27, 2026

❌ Gradle check result for 85593b9: FAILURE

Please examine the workflow log, locate, and copy-paste the failure(s) below, then iterate to green. Is the failure a flaky test unrelated to your change?

@karenyrx
Add guide for contributing to gRPC
aebe16c 
Signed-off-by: Karen X <karenxyr@gmail.com>
@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Jan 27, 2026

❌ Gradle check result for aebe16c: FAILURE

Please examine the workflow log, locate, and copy-paste the failure(s) below, then iterate to green. Is the failure a flaky test unrelated to your change?

@varunbharadwaj
Copy link
Copy Markdown
Contributor

varunbharadwaj commented Jan 29, 2026

Thanks for adding the gRPC guide! Very detailed!

@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Jan 29, 2026

❌ Gradle check result for aebe16c: FAILURE

Please examine the workflow log, locate, and copy-paste the failure(s) below, then iterate to green. Is the failure a flaky test unrelated to your change?

@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Jan 30, 2026

❌ Gradle check result for aebe16c: FAILURE

Please examine the workflow log, locate, and copy-paste the failure(s) below, then iterate to green. Is the failure a flaky test unrelated to your change?

@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Feb 1, 2026

❕ Gradle check result for aebe16c: UNSTABLE

Please review all flaky tests that succeeded after retry and create an issue if one does not already exist to track the flaky failure.

@karenyrx karenyrx merged commit 93ae8db into opensearch-project:main Feb 1, 2026
37 of 43 checks passed
This was referenced Feb 18, 2026
Open
Open
Closed
Open
Open
tanyabti pushed a commit to tanyabti/OpenSearch that referenced this pull request Feb 24, 2026
@karenyrx @tanyabti
Add guide for contributing to gRPC (opensearch-project#20474)
670cc94 
Signed-off-by: Karen X <karenxyr@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@sandeshkr419 sandeshkr419 sandeshkr419 left review comments

@varunbharadwaj varunbharadwaj varunbharadwaj approved these changes

Assignees

No one assigned

Labels

skip-changelog

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@karenyrx @varunbharadwaj @sandeshkr419