Skip to content

Commit

Permalink
Add: log/comment rule
Browse files Browse the repository at this point in the history
  • Loading branch information
AlexStocks committed Jan 26, 2020
1 parent deb9ea1 commit 5a71b39
Showing 1 changed file with 11 additions and 1 deletion.
12 changes: 11 additions & 1 deletion contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

0 comments on commit 5a71b39

Please sign in to comment.