From 21f5373231307963baebce08881eaae18eafdb45 Mon Sep 17 00:00:00 2001 From: LamGC Date: Sat, 24 Oct 2020 15:40:03 +0800 Subject: [PATCH] =?UTF-8?q?[Update]=20Project=20=E6=9B=B4=E6=96=B0?= =?UTF-8?q?=E8=B4=A1=E7=8C=AE=E6=8C=87=E5=8D=97=E7=9A=84=E4=BE=9D=E8=B5=96?= =?UTF-8?q?=E7=9B=B8=E5=85=B3=E8=AF=B4=E6=98=8E;?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit [Update] CONTRIBUTING.md 增加依赖相关部分, 调整其他内容的细节; --- .github/CONTRIBUTING.md | 27 ++++++++++++++++----------- 1 file changed, 16 insertions(+), 11 deletions(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 7e4dc3c..09efebf 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -19,12 +19,19 @@ ``` #### 标点符号的使用 #### -在提交信息中，符号使用英文符号。 +在提交信息中，符号使用**英文符号**。 #### 文件名或类名的说明 #### 对于类代码文件而言，FileName 只需要填写类名，对其他文件则需要包括后缀名。 FileName 和 ModuleName 可按需要使用`, `追加，注意与说明空一格， 例如: `[Add][Change] SimpleClass, MainClass 添加 SimpleClass 并调整 MainClass 的日志格式;` +ModuleName 根据修改的相关子模块名填写即可，对项目而非子模块的更改，则 ModuleName 为 `Project`，一个例子： +``` +[Change][Update][Optimize] Project, SubModule01, WebFrontend 更新项目中的Readme, 修改 SubModule01 中鉴权的实现细节, 优化Web前端模块的启动速度; +[Update] Readme.md 调整文档格式; +[Change] AuthorizationChecker 调整鉴权过程以避免潜在的错误; +[Optimize] MainClass 优化初始化速度, 移除不必要的检查步骤; +``` #### 标签的使用 #### 目前支持以下Tag: - `Add` 文件添加 @@ -33,13 +40,13 @@ FileName 和 ModuleName 可按需要使用`, `追加，注意与说明空一格 - `Delete` 文件删除 - `Document` 文档相关 - `Fix` 问题修复 -- `Optimize` 优化相关 +- `Optimize` 优化相关(或者代码整理啥的) - `Move` 文件移动(例如包更改) - `Rename` 更改名称(类名, 文件名等) - `Issue:Id` 指定 Commit 所关联的 Github Issue（如果与其他标签有关，可直接加到指定标签后方，该标签可不用加） - `PR:ID` 指定 Commit 所关联的 Pull Request（可选的，可直接使用 Github 的默认 Commit Message） -ModuleName 根据修改的相关子模块名填写即可，对项目而非子模块的更改，则 ModuleName 为 `Project`。 + 对大部分文件而言，FileName 按照以上规则填写即可，但对于依赖项而言，则要按照 GAV 坐标填写， 例如：`[Add] junit:junit 添加 Junit 单元测试依赖项;`， @@ -79,14 +86,12 @@ ModuleName 根据修改的相关子模块名填写即可，对项目而非子模 ## 代码质量 ## -如果你想添加新的功能，请务必对新功能相关代码编写好覆盖全，情况完善的单元测试！ -覆盖全，多角度，高度完善的单元测试是保证代码、项目质量必不可少的！ +如果你想添加新的功能，请务必对新功能相关代码编写好覆盖全，情况完善的单元测试（尽可能的覆盖所有新增功能，确保对大部分情况都有足够的测试）！ +覆盖全、多角度、高度完善的单元测试是保证代码、项目质量必不可少的！ 每次提交后，请检查 Action，查看 Github 中的代码是否能通过所有的单元测试。 - - - - - - +## 依赖管理 ## +请**尽可能避免引入**新依赖项，如果某个依赖项的引入，仅仅是用于某些计算，则这个引用是完全没有必要的， +对于因极少需要而引入某些依赖项时，请考虑了解依赖项内的*实现细节*，并复现在项目中，以避免引入依赖项。（当然，这是有例外的，如果某个功能较为复杂，且在该依赖项拥有很好的质量保证时，可考虑引入，具体细节可发起**issue**与我们进行讨论。） +**另外！**引入依赖项请注意**License**，确保依赖项可以被本项目使用。