diff --git a/contributing.md b/contributing.md index cce54951db45b5c8e892ed9e00ef9b3ab27f84be..b1265c2351789d4929d81556d72234806aed6afa 100644 --- a/contributing.md +++ b/contributing.md @@ -1,7 +1,7 @@ Contributing to Dubbogo ## 1. Branch - + >- The name of branches `SHOULD` be in the format of `feature/xxx`. >- You `SHOULD` checkout a new branch after a feature branch already being merged into upstream, `DO NOT` commit in the old branch. @@ -24,3 +24,8 @@ The title format of the pull request `MUST` follow the following rules: >- Start with `Dep:` for adding depending libs. >- Start with `Rem:` for removing feature/struct/function/member/files. +## 3. Code Style + +### 3.1 log + +> 1 when logging the function's input parameter, you should add '@' before input parameter name.