!150 chore: 在官网统一维护 contributing

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