From 12dba7bb07b6a80f99cc37036720e57121bf3e13 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=E5=BE=90=E6=99=93=E4=BC=9F?= <xuxiaowei@xuxiaowei.com.cn>
Date: Tue, 28 Jun 2022 14:08:19 +0800
Subject: [PATCH] =?UTF-8?q?:memo:=20=E4=BB=A3=E7=A0=81=E8=A7=84=E8=8C=83?=
 =?UTF-8?q?=E8=AF=B4=E6=98=8E?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 README.md | 15 +++++++++++++++
 1 file changed, 15 insertions(+)

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)
 
+   <details>
+    <summary>代码规范说明</summary>
+
+    1. 由于 <a href="https://github.com/spring-io/spring-javaformat" target="_blank">spring-javaformat</a>
+       强制所有代码按照指定格式排版，未按此要求提交的代码将不能通过合并（打包）
+    2. 如果使用 IntelliJ IDEA
+       开发，请安装自动格式化软件 <a href="https://repo1.maven.org/maven2/io/spring/javaformat/spring-javaformat-intellij-idea-plugin/" target="_blank">
+       spring-javaformat-intellij-idea-plugin</a>
+    3. 其他开发工具，请参考 <a href="https://github.com/spring-io/spring-javaformat" target="_blank">spring-javaformat</a>
+       说明，或`提交代码前`在项目根目录运行下列命令（需要开发者电脑支持`mvn`命令）进行代码格式化
+       ```
+       mvn spring-javaformat:apply
+       ```
+   </details>
+
 2. 欢迎提交 [issue](https://gitee.com/log4j/pig/issues)，请写清楚遇到问题的原因、开发环境、复显步骤。
 
 3. 联系作者 <a href="mailto:pig4cloud@qq.com">pig4cloud@qq.com</a>