-
Notifications
You must be signed in to change notification settings - Fork 2.4k
[GRPC] Add guide for "Contributing to gRPC" #20474
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
base: main
Are you sure you want to change the base?
Conversation
|
Important Review skippedAuto incremental reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the You can disable this status message by setting the
📝 WalkthroughWalkthroughDocumentation 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
Estimated code review effort🎯 2 (Simple) | ⏱️ ~8 minutes 🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. Comment |
Codecov Report✅ All modified and coverable lines are covered by tests. 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. 🚀 New features to boost your workflow:
|
|
❌ 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? |
Signed-off-by: Karen X <[email protected]>
|
❌ 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? |
|
Thanks for adding the gRPC guide! Very detailed! |
|
❌ 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? |
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
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.