This is an automated email from the ASF dual-hosted git repository.
zhouky pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/incubator-celeborn.git
The following commit(s) were added to refs/heads/main by this push:
new a11a5e975 [CELEBORN-927][DOC] Guideline to add new RPC messages
a11a5e975 is described below
commit a11a5e9750640ae027b8ccf3381066a1ab378f4c
Author: zky.zhoukeyong <[email protected]>
AuthorDate: Tue Aug 29 15:51:41 2023 +0800
[CELEBORN-927][DOC] Guideline to add new RPC messages
### What changes were proposed in this pull request?
As title.
### Why are the changes needed?
As title.
### Does this PR introduce _any_ user-facing change?
No.
### How was this patch tested?
Passes GA.
Closes #1851 from waitinfuture/927.
Authored-by: zky.zhoukeyong <[email protected]>
Signed-off-by: zky.zhoukeyong <[email protected]>
---
CONTRIBUTING.md | 5 +++++
1 file changed, 5 insertions(+)
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 091faf52d..cd2765cfc 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -33,3 +33,8 @@ There are already some further improvements on the schedule
and welcome to conta
8. Enhanced K8S support.
9. Support spilled data.
10. Locality awareness.
+
+## Guidelines
+### Adding RPC Messages
+When you add new RPC message, it's recommended to follow raw PB message case,
for example
+`RegisterWorker` and `RegisterWorkerResponse`. The RPC messages will be
unified into raw PB messages eventually.
