diff --git a/README.md b/README.md index 4718a567..a300c077 100644 --- a/README.md +++ b/README.md @@ -130,6 +130,21 @@ pig 开源软件遵循 [Apache 2.0 协议](https://www.apache.org/licenses/LICEN 1. 欢迎提交 [PR](https://dwz.cn/2KURd5Vf),注意对应提交对应 `dev` 分支 代码规范 [spring-javaformat](https://github.com/spring-io/spring-javaformat) +
+ 代码规范说明 + + 1. 由于 spring-javaformat + 强制所有代码按照指定格式排版,未按此要求提交的代码将不能通过合并(打包) + 2. 如果使用 IntelliJ IDEA + 开发,请安装自动格式化软件 + spring-javaformat-intellij-idea-plugin + 3. 其他开发工具,请参考 spring-javaformat + 说明,或`提交代码前`在项目根目录运行下列命令(需要开发者电脑支持`mvn`命令)进行代码格式化 + ``` + mvn spring-javaformat:apply + ``` +
+ 2. 欢迎提交 [issue](https://gitee.com/log4j/pig/issues),请写清楚遇到问题的原因、开发环境、复显步骤。 3. 联系作者 pig4cloud@qq.com