Skip to content

Conversation

@karenyrx
Copy link
Contributor

@karenyrx karenyrx commented Jan 26, 2026

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
Contributor

coderabbitai bot commented Jan 26, 2026

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
Contributor

✅ Gradle check result for fe4380e: SUCCESS

@codecov
Copy link

codecov bot commented Jan 26, 2026

Codecov Report

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

Additional details and impacted files
@@             Coverage Diff              @@
##               main   #20474      +/-   ##
============================================
+ Coverage     73.25%   73.33%   +0.08%     
- Complexity    71979    72008      +29     
============================================
  Files          5796     5796              
  Lines        329287   329287              
  Branches      47419    47419              
============================================
+ Hits         241203   241489     +286     
+ Misses        68759    68446     -313     
- Partials      19325    19352      +27     

☔ 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
@github-actions
Copy link
Contributor

❌ 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?

@github-actions
Copy link
Contributor

❌ 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
Contributor

Thanks for adding the gRPC guide! Very detailed!

@github-actions
Copy link
Contributor

❌ 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?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants