From 652f2fc50b80e3b7428270fc7c9c0570b581ecbf Mon Sep 17 00:00:00 2001 From: Looly Date: Thu, 22 Sep 2022 16:20:12 +0800 Subject: [PATCH] fix template --- .github/PULL_REQUEST_TEMPLATE.md | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 6a5dae969..6f6bbf520 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -7,4 +7,13 @@ ### 修改描述(包括说明bug修复或者添加新特性) 1. [bug修复] balabala…… -2. [新特性] balabala…… \ No newline at end of file +2. [新特性] balabala…… + +### 提交前自测 +> 请在提交前自测确保代码没有问题，提交新代码应包含：测试用例、通过(mvn javadoc:javadoc)检验详细注释。 + +1. 本地如有多个JDK版本，可以设置临时JDk版本,如：`export JAVA_HOME=/Library/Java/JavaVirtualMachines/jdk1.8.0_331.jdk/Contents/Home`，具体替换为本地jdk目录 +2. 确保本地测试使用JDK8最新版本，`echo $JAVA_HOME`、`mvn -v`、`java -version`均正确。 +3. 执行打包生成文档，使用`mvn clean package -Dmaven.test.skip=true -U`，并确认通过，会自动执行打包、生成文档 +4. 如需要单独执行文档生成，执行：`mvn javadoc:javadoc `，并确认通过 +5. 如需要单独执行测试用例，执行：`mvn clean test`，并确认通过 \ No newline at end of file