📃 docs(contributing): rewrite contributing

docs/client/index.md

@@ -14,53 +14,19 @@ Minecraft 客户端，是 Minecraft 游戏本身一大组成部分。通俗来
 
 游戏的文件目录一般如下所示。
 
-```
+```filetree
 .minecraft
 ├─assets
 │  ├─indexes
 │  ├─objects
 │  │  ├─00
 │  │  ├─01
-│  │  ├─02
-│  │  ├─03
-│  │  ├─04
-│  │  ├─05
-│  │  ├─06
-│  │  ├─07
-│  │  ├─08
-│  │  ├─09
-│  │  ├─0a
-│  │  ├─0b
-│  │  ├─0c
-│  │  ├─0d
-│  │  ├─0e
-│  │  ├─0f
-│  │  ├─10
-│  │  ├─11
-│  │  ├─12
 │  │  ├─...
 │  │  ├─fe
 │  │  └─ff
 │  ├─skins
 │  │  ├─00
 │  │  ├─01
-│  │  ├─02
-│  │  ├─03
-│  │  ├─04
-│  │  ├─05
-│  │  ├─06
-│  │  ├─07
-│  │  ├─08
-│  │  ├─09
-│  │  ├─0a
-│  │  ├─0b
-│  │  ├─0c
-│  │  ├─0d
-│  │  ├─0e
-│  │  ├─0f
-│  │  ├─10
-│  │  ├─11
-│  │  ├─12
 │  │  ├─...
 │  │  ├─fe
 │  │  └─ff

docs/contribute/contributing.md

@@ -1,72 +1,91 @@
 ---
-contributors: [HRxiaohu]
+contributors: [HRxiaohu, bingling-sama]
 ---
 
 # 贡献指南
 
-## 排版标准
+在向 CrashMC 贡献内容前，请务必仔细阅读以下贡献流程，以便我们进行代码审查工作。
 
-请先 Fork 本仓库，然后进行文档修改。排版时请务必遵循中文文案排版指北。
+## Step1.克隆项目
 
-请注意：在非 Log 信息以外的任何地方，如果出现中文文字、英文单词和阿拉伯数字混用的情况，请在它们之间添加空格；如果有斜杠的，请在斜杠两边增加一个空格。
 
-例：`GlobeMC 河豚分析是一个 2023 年 7 月底成立的崩溃日志分析组织，以方便 / 开放 / 专业为目标`、`Java 8`
+首先 fork [GitHub Repo](https://github.com/GlobeMC/crashmc.com) 到你名下，然后克隆仓库到本地：
 
-在涉及非 Log 信息以外的任何地方，英文单词原则上首字母大写，部分情况需要按照规则大写，英文句子首字母大写。
+```bash
+# 推荐使用 SSH
+git clone git@github.com:{yourname}/crashmc.com.git
+# 也可以使用 HTTPS （不推荐）
+git clone https://github.com/{yourname}/crashmc.com.git 
+```
 
-例：`Minecraft`、`OptiFine`、`What your love is your life`。
+推荐使用 [VSCode](https://code.visualstudio.com/) 编辑内容。
 
-在涉及路径时，请在路径的前后加上空格。
+:::tip GitHub Web Editor
+如果内容较少，你可以直接使用 [GitHub Web Editor](https://github.dev) 来进行修改。
 
-例：`路径 D:/PCL/.minecraft/mods 是存放 Mods 的地方`
+但同样，你需要先将 Repo fork 你自己名下，以便后期进行 pr。
+:::
 
-所有专有名词都应该使用反引号 `` ` `` 包裹。
+## Step2.贡献内容
 
-例：`` `Minecraft` ``、`` `Curseforge` ``、`` `MC百科` ``
 
-在涉及任何站外链接时，请优先添加官方链接，尽量避免不必要的第三方链接。
+### 文档内容
 
-如果某一个解决方案为特定启动器独占功能，我们提供了全局组件来标注它。示例如下：
+本文档按 [W3C Requirement for Chinese Text Layout](https://www.w3.org/International/clreq/) 进行排版，在贡献内容时请注意排版格式。
 
-:::tip HMCL
+在涉及任何站外链接时，请优先添加官方链接，尽量避免不必要的第三方链接。
 
-### 修改渲染器 <LauncherBadge type="hmcl" text="仅 HMCL" />
+如果某一个解决方案为特定启动器独占功能，我们提供了全局组件来标注它。示例如下：
 
-```md
-### 修改渲染器 <LauncherBadge type="hmcl" text="仅 HMCL" />
+```markdown
+<LauncherBadge type="hmcl" text="仅 HMCL" />
+<LauncherBadge type="bakaxl" text="仅 BakaXL" />
+<LauncherBadge type="pcl" text="仅 PCL2" />
 ```
 
-:::
+实际效果：
 
-:::tip BakaXL
+- <LauncherBadge type="hmcl" text="仅 HMCL" />
+- <LauncherBadge type="bakaxl" text="仅 BakaXL" />
+- <LauncherBadge type="pcl" text="仅 PCL2" />
 
-### 重置核心 <LauncherBadge type="bakaxl" text="仅 BakaXL" />
+如果您参与编辑了一篇文档的绝大部分，可以填写 Markdown Frontmatter contributor 字段，以将您的 GitHub 用户名添加到贡献者列表，格式如下。
 
 ```md
-### 重置核心 <LauncherBadge type="bakaxl" text="仅 BakaXL" />
+---
+contributors: [username1, username2]
+---
 ```
 
+:::warning 警告
+
+- 请一定要使用 GitHub 用户名署名，否则我们无法获取您的头像。
+- 上述代码中所使用的均为英文半角逗号！
+
 :::
 
-:::tip PCL2
+### 代码内容
 
-### 修改验证服务器 <LauncherBadge type="pcl" text="仅 PCL2" />
+如果您参与了代码内容的修改，~~相信您应该多少懂一些贡献流程，~~ 这里不再过多赘述贡献流程。
 
-```md
-### 修改验证服务器 <LauncherBadge type="pcl" text="仅 PCL2" />
-```
+## Step3.提交更改
 
+在完成内容编写以后，请将您的所有更改 commit 到您的 fork 下，再向 [这里](https://github.com/GlobeMC/crashmc.com/tree/dev) 提交 pr。
+
+:::warning 重要提醒
+请务必将您的更改 pr 到 `dev` barnch，以便我们审查排版及合并冲突。
 :::
 
-在您完成文档修改后，请在 Markdown 文档的最上方修改 contributors Frontmatter，以将您的 GitHub 用户名添加到贡献者列表，格式如下。
+:::tip Assign
+如果您的更改范围为文档相关，请 Assign `@bingling-sama`、`@xxx` 或 `@xxx`，这会加快我们对您的代码审查与合并速度。
+:::
 
-```md
----
-contributors: [用户名, 用户名, 用户名]
----
-```
+## Step4.剩余流程
 
-:::warning 警告
-- 请一定要使用 GitHub 用户名署名，否则我们无法获取您的头像。
-- 上述代码中所使用的均为英文半角逗号！
-:::
+在收到您的 pr 后，我们会尽最快速度 review 您的代码，并合并到 `dev` branch。
+
+我们会每周进行一次例行 merge，将所有已完成的更改合并到生产环境 `main` branch，因此请不要将您的更改 pr 到 `main` branch，这会增大我们的代码审查和文档部署工作量。
+
+## 鸣谢
+
+感谢所有为 CrashMC 贡献内容的玩家和开发者，你们的支持是对 CrashMC 最大的鼓励。