From 879d136fe7988e7233cc0146c2d607f4cfcbfb77 Mon Sep 17 00:00:00 2001
From: SherkeyXD <57581480+SherkeyXD@users.noreply.github.com>
Date: Sun, 21 Jul 2024 01:45:24 +0800
Subject: [PATCH] =?UTF-8?q?docs:=20=E6=B7=BB=E5=8A=A0=20MAA=20=E6=A0=BC?=
 =?UTF-8?q?=E5=BC=8F=E5=8C=96=E8=A6=81=E6=B1=82=E8=AF=B4=E6=98=8E?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 docs/zh-cn/develop/development.md | 31 +++++++++++++++++++++++++++++--
 docs/zh-cn/readme.md              |  2 +-
 2 files changed, 30 insertions(+), 3 deletions(-)

diff --git a/docs/zh-cn/develop/development.md b/docs/zh-cn/develop/development.md
index 64638b111a..1b6c08f063 100644
--- a/docs/zh-cn/develop/development.md
+++ b/docs/zh-cn/develop/development.md
@@ -3,7 +3,7 @@ order: 1
 icon: iconoir:developer
 ---
 
-# 开始开发
+# 开发前须知
 
 ## Github Pull Request 流程简述
 
@@ -94,7 +94,34 @@ icon: iconoir:developer
 在打开 VS2022 之后，和 git 有关的操作可以不用命令行工具，直接使用 vs 自带的“Git 更改”即可
 :::
 
-## 在 Visual Studio 中启用 clang-format
+## MAA 的文件格式化要求
+
+MAA 使用一系列的格式化工具来保证仓库中的代码和资源文件美观统一，以便于维护和阅读
+
+请确保在提交之前已经格式化，或是[启用 Pre-commit Hooks 来进行自动格式化](#利用-pre-commit-hooks-自动进行代码格式化)
+
+目前启用的格式化工具如下：
+
+| 文件类型 | 格式化工具 |
+| --- | --- |
+| C++ | [clang-format](https://clang.llvm.org/docs/ClangFormat.html) |
+| Json/Yaml | [Prettier](https://prettier.io/) |
+| Markdown | [markdownlint](https://github.com/DavidAnson/markdownlint-cli2) |
+
+### 利用 Pre-commit Hooks 自动进行代码格式化
+
+1. 确保你的电脑上有 Python 与 Node 环境
+
+2. 在项目根目录下执行以下命令
+
+    ```bash
+    pip install pre-commit
+    pre-commit install
+    ```
+
+接下来，每次提交时都将会自动运行格式化工具，来确保你的代码格式符合规范
+
+### 在 Visual Studio 中启用 clang-format
 
 1. 安装 clang-format 17 或更高版本
 
diff --git a/docs/zh-cn/readme.md b/docs/zh-cn/readme.md
index fa7bfd6dfb..85caf8d0d8 100644
--- a/docs/zh-cn/readme.md
+++ b/docs/zh-cn/readme.md
@@ -125,7 +125,7 @@ MAA 以中文（简体）为第一语言，翻译词条均以中文（简体）
 
 #### Windows
 
-请参阅 [开始开发](./develop/development.md)。
+请参阅 [开发前须知](./develop/development.md)。
 
 #### Linux | macOS