docs: update CONTRIBUTING.md
This commit is contained in:
30
.github/CONTRIBUTING.md
vendored
30
.github/CONTRIBUTING.md
vendored
@@ -150,36 +150,32 @@ public final class RemoveShakeAdExampleHook extends CommonSwitchFunctionHook {
|
|||||||
|
|
||||||
## Pull Request
|
## Pull Request
|
||||||
|
|
||||||
1. 请勿在修改会被编译分发至用户的部分时在PR标题添加[skip ci];请务必在文档、模板等不会影响编译流程和实际分发的目标生成,或完全无法编译但出于必要目的必须提交的PR标题添加[skip ci]
|
1. 请勿在修改会被编译分发至用户的部分时在 PR 标题添加 [skip ci];请务必在文档、模板等不会影响编译流程和实际分发的目标生成,或完全无法编译但出于必要目的必须提交的 PR 标题添加 [skip ci]
|
||||||
|
|
||||||
## 开发
|
## 注意事项
|
||||||
|
|
||||||
1. 请确认您的编辑器支持EditorConfig,否则请注意您的编码、行位序列及其其他事项。
|
1. 请确认您的编辑器支持 EditorConfig,否则请注意您的编码、行位序列等事项。
|
||||||
|
|
||||||
2. 在原则上代码风格遵循[Google Java Style](https://google.github.io/styleguide/javaguide.html)[中文翻译](https://github.com/fantasticmao/google-java-style-guide-zh_cn)
|
2. 代码风格建议遵循 [Google Java Style](https://google.github.io/styleguide/javaguide.html) [中文翻译](https://github.com/fantasticmao/google-java-style-guide-zh_cn)
|
||||||
|
|
||||||
3. 每位开发者的代码风格应保持一致
|
3. 每位开发者自己的代码风格应保持一致
|
||||||
|
|
||||||
4. 以UTF-8编码,以LF作为行位序列
|
4. 以 UTF-8 编码,以 LF 作为行位序列
|
||||||
|
|
||||||
5. 命名方面应
|
5. 命名方面: 禁止拼音 (参考上面的例外)
|
||||||
1. 禁止拼音
|
|
||||||
|
|
||||||
2. 使用大写字母分隔单词
|
6. 使用 4 个空格缩进 (Java/Kotlin/C++)
|
||||||
6. 使用4个空格缩进
|
|
||||||
|
|
||||||
7. 弃用或注释的代码应删除,若需重复使用请翻阅git log
|
7. 弃用或注释的代码应删除,若需重复使用请翻阅 `git log`
|
||||||
|
|
||||||
8. 大括号放应同一行上
|
8. 大括号放应同一行上 (Java/Kotlin/C++)
|
||||||
|
|
||||||
9. 代码请务必格式化
|
9. 代码请务必格式化
|
||||||
|
|
||||||
10. 将自己的代码放在自己的包里,,另外,应注意的是,如果你创建了自己的包,**一定要记得修改[proguard-rules.pro](app/proguard-rules.pro)**
|
10. 将自己的代码放在自己的包里,另外,应注意的是,如果你创建了自己的包,**一定要记得修改 [proguard-rules.pro](app/proguard-rules.pro)**
|
||||||
|
|
||||||
11. 除个别情况,必须添加代码头
|
11. 除例外情况外,原则上要求添加代码头 (例外情况: 反编译的代码、自动生成的代码、非贡献者编写的代码、由于文件格式或其它原因不适合添加代码头等)
|
||||||
|
|
||||||
12. **在任何时候,您都不应该随意更改[build.gradle.kts](build.gradle.kts),特别是升级 `com.android.tools.build:gradle` 版本**
|
|
||||||
|
|
||||||
## 其他
|
## 其他
|
||||||
|
|
||||||
如还有疑问,可直接在Telegram群聊询问
|
如还有疑问,可直接在 Telegram 群聊询问
|
||||||
|
|||||||
Reference in New Issue
Block a user