From 7024510df90e38f36b06b957b67ea8128546c109 Mon Sep 17 00:00:00 2001 From: LamGC Date: Sun, 8 Nov 2020 20:57:28 +0800 Subject: [PATCH] =?UTF-8?q?[Update]=20Project=20=E4=BF=AE=E5=A4=8D?= =?UTF-8?q?=E8=B4=A1=E7=8C=AE=E6=8C=87=E5=8D=97=E4=B8=AD=E7=9A=84=E4=B8=80?= =?UTF-8?q?=E4=BA=9B=E7=BB=86=E8=8A=82=E9=97=AE=E9=A2=98,=20=E8=A1=A5?= =?UTF-8?q?=E5=85=85=E9=83=A8=E5=88=86=E5=86=85=E5=AE=B9=E7=9A=84=E7=BB=86?= =?UTF-8?q?=E8=8A=82;?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit [Update] .github/CONTRIBUTING.md 修复 Review 中指出的问题, 补充部分内容的细节; --- .github/CONTRIBUTING.md | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index b09795d..81ffe0f 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -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 按照以上规则填写即可，但对于依赖项而言，则要按照 GAV（GroupId:ArtifactId:Version）坐标去除 **Version** 项后填写， 例如：`[Add] junit:junit 添加 Junit 单元测试依赖项;`， @@ -88,15 +88,16 @@ ModuleName 根据修改的相关子模块名填写即可，对项目而非子模 ... ``` - ## 代码质量 ## 如果你想添加新的功能，请务必对新功能相关代码编写好覆盖全，情况完善的单元测试（尽可能的覆盖所有新增功能，确保对大部分情况都有足够的测试）！ 覆盖全、多角度、高度完善的单元测试是保证代码、项目质量必不可少的！ 每次提交后，请检查 Action，查看 Github 中的代码是否能通过所有的单元测试。 ## 依赖管理 ## -> 请**尽可能避免引入**新依赖项，如果某个依赖项的引入，仅仅是用于某些计算，则这个引用是完全没有必要的。 +> 请**尽可能避免引入**新依赖项，如果某个依赖项的引入，仅仅是用于某些计算（或某个小功能，比如仅使用 Apache Commons 中的 `RandomUtils` 类获取 long 类型的随机数）， +则这个依赖项的引入是完全没有必要的。 -对于因极少需要而引入某些依赖项时，请考虑了解依赖项内的*实现细节*，并复现在项目中，以避免引入依赖项。（当然，这是有例外的，如果某个功能较为复杂，且在该依赖项拥有很好的质量保证时，可考虑引入，具体细节可发起**issue**与我们进行讨论。） +对于因极少需要而引入某些依赖项时，请考虑了解依赖项内的*实现细节*，并复现在项目中，以避免引入依赖项。 +（当然，这是有例外的，如果某个功能较为复杂，且在该依赖项拥有很好的质量保证时，可考虑引入，具体细节可发起**issue**与我们进行讨论。） **另外！**引入依赖项请注意**License**，确保依赖项可以被本项目使用。