[Update] Project 修复贡献指南中的一些细节问题, 补充部分内容的细节;

[Update] .github/CONTRIBUTING.md 修复 Review 中指出的问题, 补充部分内容的细节;
This commit is contained in:
LamGC 2020-11-08 20:57:28 +08:00 committed by GitHub
parent 97d10fc1da
commit 7024510df9
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -6,7 +6,7 @@
欢迎你为本项目作出贡献!本项目的发展离不开所有贡献者(不仅仅只是提交了相关代码,帮助编写文档,还是提出问题或想法也算是贡献者之一!)的贡献。
在为本项目作出任何贡献之前,请先阅读[贡献者准则](https://github.com/LamGC/ContentGrabbingJi/blob/3.0.0/CODE_OF_CONDUCT.md)
一旦你尝试(或正在)为本项目贡献,即代表你**认同并接受**贡献者准则,**清楚明白且接受**因**违反贡献者准则**所造成的后果。
一旦你尝试(或正在)为本项目贡献(贡献中,或者贡献过),即代表你**认同并接受**贡献者准则,**清楚明白且接受**因**违反贡献者准则**所造成的后果。
## 代码规范 ##
本项目代码规范大部分遵循 《Alibaba Java Coding Guidelines》
@ -50,7 +50,7 @@ ModuleName 根据修改的相关子模块名填写即可,对项目而非子模
- `Issue:Id` 指定 Commit 所关联的 Github Issue如果与其他标签有关可直接加到指定标签后方该标签可不用加
- `PR:ID` 指定 Commit 所关联的 Pull Request可选的可直接使用 Github 的默认 Commit Message
> 注意:后续如有需要,会追加一些标签。
对大部分文件而言FileName 按照以上规则填写即可,但对于依赖项而言,则要按照 GAVGroupId:ArtifactId:Version坐标去除 **Version** 项后填写,
例如:`[Add] junit:junit 添加 Junit 单元测试依赖项;`
@ -88,15 +88,16 @@ ModuleName 根据修改的相关子模块名填写即可,对项目而非子模
...
```
## 代码质量 ##
如果你想添加新的功能,请务必对新功能相关代码编写好覆盖全,情况完善的单元测试(尽可能的覆盖所有新增功能,确保对大部分情况都有足够的测试)!
覆盖全、多角度、高度完善的单元测试是保证代码、项目质量必不可少的!
每次提交后,请检查 Action查看 Github 中的代码是否能通过所有的单元测试。
## 依赖管理 ##
> 请**尽可能避免引入**新依赖项,如果某个依赖项的引入,仅仅是用于某些计算,则这个引用是完全没有必要的。
> 请**尽可能避免引入**新依赖项,如果某个依赖项的引入,仅仅是用于某些计算(或某个小功能,比如仅使用 Apache Commons 中的 `RandomUtils` 类获取 long 类型的随机数),
则这个依赖项的引入是完全没有必要的。
对于因极少需要而引入某些依赖项时,请考虑了解依赖项内的*实现细节*,并复现在项目中,以避免引入依赖项。(当然,这是有例外的,如果某个功能较为复杂,且在该依赖项拥有很好的质量保证时,可考虑引入,具体细节可发起**issue**与我们进行讨论。)
对于因极少需要而引入某些依赖项时,请考虑了解依赖项内的*实现细节*,并复现在项目中,以避免引入依赖项。
(当然,这是有例外的,如果某个功能较为复杂,且在该依赖项拥有很好的质量保证时,可考虑引入,具体细节可发起**issue**与我们进行讨论。)
**另外!**引入依赖项请注意**License**,确保依赖项可以被本项目使用。