test/Jpom
1
0
Fork 0
mirror of https://gitee.com/dromara/Jpom.git synced 2024-11-29 18:38:32 +08:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

update CONTRIBUTING.md

Browse Source
This commit is contained in:
bwcx_jzy 2022-05-16 17:12:21 +08:00
parent 45cb2b16c6
commit 2da11c2806
No known key found for this signature in database
GPG Key ID: 5E48E9372088B9E5
1 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README_CONTRIBUTE.md → CONTRIBUTING.md
View File

@ -22,9 +22,9 @@
## 一些规范说明 ## 一些规范说明
1. 写完代码后在保证不影响其他的人的代码情况下尽量统一格式化一下代码 1. 写完代码后在保证不影响其他的人的代码情况下尽量统一格式化一下代码
1. 采用 4 个空格缩进，禁止使用 tab 字符 1. 采用 4 个空格缩进，禁止使用 tab 字符
2. 如果使用 tab 缩进，必须设置 1 个 tab 为 4 个空格。IDEA 设置 tab 为 4 个空格时， 2. 如果使用 tab 缩进，必须设置 1 个 tab 为 4 个空格。IDEA 设置 tab 为 4 个空格时，
请勿勾选 Use tab character；而在 eclipse 中，必须勾选 insert spaces for tabs 请勿勾选 Use tab character；而在 eclipse 中，必须勾选 insert spaces for tabs
2. Java 代码需要保证新增方法都有充足、标准的 JavaDoc 注释 2. Java 代码需要保证新增方法都有充足、标准的 JavaDoc 注释
3. 在修改 Bug、新增功能尽量保证最小提交的方式提交代码，减少多个功能一个 commit 3. 在修改 Bug、新增功能尽量保证最小提交的方式提交代码，减少多个功能一个 commit
4. 所有接口 url 都需要遵循下划线模式 4. 所有接口 url 都需要遵循下划线模式
@ -34,8 +34,8 @@
8. 所有 controller 层的接口都需要添加文档注释（至少包含接口的作用说明、参数说明、返回值说明及添加 apiDoc 文档注释） 8. 所有 controller 层的接口都需要添加文档注释（至少包含接口的作用说明、参数说明、返回值说明及添加 apiDoc 文档注释）
> 注：由于旧代码存在很多不规范问题，会逐步调整为新规范。在新写的代码都需要需要遵循上面说明 > 注：由于旧代码存在很多不规范问题，会逐步调整为新规范。在新写的代码都需要需要遵循上面说明
> >
> >
### 类的文档注释规范（Javadoc） ### 类的文档注释规范（Javadoc）
``` ```