From b1b2224c6bf47ab4aea6f3f2e4805b3da64cf6e1 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=E8=81=AA=E5=B0=8F=E9=99=88?= <448627663@qq.com>
Date: Tue, 20 Feb 2024 04:49:41 +0000
Subject: [PATCH] =?UTF-8?q?!150=20chore:=20=E5=9C=A8=E5=AE=98=E7=BD=91?=
 =?UTF-8?q?=E7=BB=9F=E4=B8=80=E7=BB=B4=E6=8A=A4=20contributing=20*=20chore?=
 =?UTF-8?q?:=20contributing=20docs?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 CONTRIBUTING.md | 54 ++-----------------------------------------------
 1 file changed, 2 insertions(+), 52 deletions(-)

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 46d6888f..b1329f39 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -1,53 +1,3 @@
-## 代码注释
+# Inula Contributing Guide
 
-为提高代码的可读性，我们希望你能按照以下几条规则编写注释，
-
-- 核心：```不要解释是什么，而是回答为什么```
-
-- 统一的注释风格
-
-  ``` 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;
-  ```
-
-- 巧妙或复杂的代码要添加注释解释逻辑
-
-- 对所有导出的顶层模块进行注释
-
-- 注释应该是直接的，不要有不明确的表达或符号
+查看[贡献指南](https://docs.openinula.net/docs/%E8%B4%A1%E7%8C%AE%E6%8C%87%E5%8D%97)获取完整指南。