docs: update develop

elonchen · Apr 30, 2020 · b75592f · b75592f
1 parent 3b4be96
commit b75592f
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -223,6 +223,12 @@ _²Right-click turns the screen on if it was off, presses BACK otherwise._
 ## DEVELOP
 [DEVELOP](docs/DEVELOP.md)
 
+Everyone is welcome to maintain this project and contribute your own code, but please follow these requirements:
+1. pr please mention the dev branch, not the master branch
+2. Please rebase dev before mentioning pr
+3. pr please submit on the principle of a small number of times (a small function point is recommended to mention a pr)
+4. Please keep the code style consistent with the existing style
+
 ## Why develop QtScrcpy?
 There are several reasons listed as below according to importance (high to low).
 1. In the process of learning Qt, I need a real project to try

diff --git a/README_zh.md b/README_zh.md
@@ -222,6 +222,12 @@ Mac OS平台，你可以直接使用我编译好的可执行程序:
 ## 开发者
 [开发者相关](docs/DEVELOP.md)
 
+欢迎大家一起维护这个项目，贡献自己的代码，不过请遵循一下几点要求：
+1. pr请提到dev分支，不要提到master分支
+2. 提pr之前请先rebase dev
+3. pr请以少量多次的原则提交（建议一个小的功能点提一个pr）
+4. 代码风格请保持和已有风格一致
+
 ## 为什么开发QtScrcpy？
 综合起来有以下几个原因，比重从大到小排列：
 1. 学习Qt的过程中需要一个项目实战一下