From b026ca8786b1a27f494fff6eb1ebc33566d86e31 Mon Sep 17 00:00:00 2001
From: cgj <18700163154@163.com>
Date: Thu, 28 Dec 2023 17:35:46 +0800
Subject: [PATCH] =?UTF-8?q?[comment]=E6=B7=BB=E5=8A=A0CONTRIBUTING.md?=
 =?UTF-8?q?=EF=BC=8C=E5=8C=85=E5=90=AB=E4=B8=80=E4=BA=9B=E6=B3=A8=E9=87=8A?=
 =?UTF-8?q?=E7=9B=B8=E5=85=B3=E7=9A=84=E5=BB=BA=E8=AE=AE?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 CONTRIBUTING.md | 53 +++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 53 insertions(+)
 create mode 100644 CONTRIBUTING.md

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 00000000..46d6888f
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,53 @@
+## 代码注释
+
+为提高代码的可读性，我们希望你能按照以下几条规则编写注释，
+
+- 核心：```不要解释是什么，而是回答为什么```
+
+- 统一的注释风格
+
+  ``` tsx
+    /**
+    * 这是块级注释
+    */
+
+    // 这是行内注释
+    
+    //============================== 分隔符 ==============================
+  ```
+
+- 注释不要重复代码内容
+
+  ``` tsx
+  // 注释和代码含义相同，无需添加
+  // error是个promise
+  if (isPromise(error)) {
+    ...
+  }
+  ```
+
+- 注释不要解释模糊代码
+
+  ``` tsx
+  // 最佳节点
+  let n: Node | null = null;
+  ```
+
+  直接在代码中通过名称表达清楚，可以省略掉注释
+
+  ``` tsx
+  let bestNode: Node | null = null;
+  ```
+
+  如果添加注释则是补充性的额外信息
+
+  ```tsx
+  // 全局指针，在遍历时指向当前最佳的节点
+  let bestNode: VNode | null = null;
+  ```
+
+- 巧妙或复杂的代码要添加注释解释逻辑
+
+- 对所有导出的顶层模块进行注释
+
+- 注释应该是直接的，不要有不明确的表达或符号