From 5a71b395da8ebedcae739469d0e1aaa63d63b60e Mon Sep 17 00:00:00 2001 From: AlexStocks <alexstocks@foxmail.com> Date: Sun, 26 Jan 2020 16:13:50 +0800 Subject: [PATCH] Add: log/comment rule --- contributing.md | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/contributing.md b/contributing.md index b1265c235..9ee2dae32 100644 --- a/contributing.md +++ b/contributing.md @@ -28,4 +28,14 @@ The title format of the pull request `MUST` follow the following rules: ### 3.1 log -> 1 when logging the function's input parameter, you should add '@' before input parameter name. +>- 1 when logging the function's input parameter, you should add '@' before input parameter name. + +### 3.2 naming + +>- 1 do not use an underscore in package name, such as `filter_impl`. +>- 2 do not use an underscore in constants, such as `DUBBO_PROTOCOL`. use 'DubboProtocol' instead. + +### 3.3 comment + +>- 1 there should be comment for every export func/var. +>- 2 the comment should begin with function name/var name. \ No newline at end of file -- GitLab