添加贡献指南

Author: northword

README.md

@@ -12,7 +12,7 @@
 
 ## 贡献指南
 
-见
+见 <https://zotero-zh.netlify.app/about/contributing/CONTRIBUTING.html>
 
 ## 致谢
 

src/.vuepress/navbar.ts

@@ -20,12 +20,12 @@ export const zhNavbar = navbar([
       {
         text: "插件开发手册",
         icon: "code",
-        link: "/plugin-dev-guide/"
+        link: "/plugin-dev-guide/",
       },
       {
         text: "CSL 中文文档",
         icon: "code",
-        link: "/csl-dev-guide/"
+        link: "/csl-dev-guide/",
       },
     ],
   },
@@ -36,13 +36,13 @@ export const zhNavbar = navbar([
       {
         text: "贡献指南",
         icon: "creative",
-        link: "/contribution-guide/"
+        link: "/about/contributing.md",
       },
       {
         text: "关于",
         icon: "about",
-        link: "/about/"
-      }
-    ]
+        link: "/about/",
+      },
+    ],
   },
 ]);

src/.vuepress/sidebar.ts

@@ -4,6 +4,6 @@ export const zhSidebar = sidebar({
   "/user-guide/": "structure",
   "/plugin-dev-guide/": "structure",
   "/csl-dev-guide/": "structure",
-  "/contribution-guide/": "structure",
-  "/": "heading",
+  "/about/": "structure",
+  "/": "structure",
 });

src/about/README.md

@@ -0,0 +1,5 @@
+---
+title: 关于
+---
+
+# 关于

src/about/contributing/CONTRIBUTING.md

@@ -0,0 +1,82 @@
+---
+title: 贡献指南
+icon: build
+order: 1
+date: 2023-07-20 23:05:53
+updated: 2023-07-21 11:56:02
+---
+
+# 贡献指南
+
+Zotero 中文文档接受多种形式的贡献，请阅读这一份指南，以更快、更有效地参与到文档的维护中。
+
+## 文档维护的内容和主要方式
+
+文档的维护与更新主要包括几个方面：
+
+- 修正错别字、语句不通等
+- 修正文档中的错误或不清晰的描述
+- 调整章节结构，使文档条理更清晰
+- 增加示例、专题或入门教程
+- 等
+
+参与文档的维护的主要方式：
+
+1. 在 GitHub 上的文档源码仓库下 [提交 ISSUE](https://github.com/zotero-chinese/wiki/issues)
+2. 在 GitHub 上的文档源码仓库下的 Discussions 上留言（也可以直接点击文档网页底部的“参与讨论”）
+3. ~~在网页底部评论区留言~~ (暂未上线)
+4. 修改文档源码并提交 Pull Request （不熟悉 Pull Request 的读者可以参考 Pull Request 流程）
+
+## 提交 / 参与议题 / 讨论
+
+:::note
+
+读者需要一个 GitHub 账户才能提交发起或参与 ISSUE 讨论。
+
+:::
+
+## 修改文档
+
+若只是对文档做简单的微调，比如修改简单的别字、语句不通或不清晰的描述等，可以直接通过 GitHub 在线修改并提交，参阅后文 [简单修改](#简单修改)。
+
+若需要对文档做大量修改，可在经过讨论后，选择 [线下修改](./build.md)。
+
+:::note
+
+若不熟悉 Markdown 标记语言，可以参考 [Markdown 语法指南](./markdown.md)。
+
+:::
+
+:::note
+
+文档源码开源托管在 [GitHub](https://github.com/) 上，因此读者需要一个 GitHub 账户才能提交 PR。
+
+:::
+
+### 简单修改
+
+1. 在线修改
+
+   点击文档网页右上角的 “在 GitHub 上编辑此页”，网页会自动跳转到文档源码文件。点击源码右上方的铅笔符号
+
+   “Edit this file”，即可在线修改。此过程会自动复制（Fork）仓库至个人 GitHub 帐号中。
+
+2. 提交修改
+
+   修改完后，在下方的 “Commit changes” 中输入有关此次修改的标题和具体描述。输入一个简短的新分支名字。
+
+   点击 “Commit changes” 提交修改。
+
+3. 提交 PR
+
+   在 “Open a pull request” 页面中，输入此 PR 的标题和具体描述。点击 “Create pull request” 即可。
+
+### 大量修改
+
+请参考 [构建指南](build.md)。
+
+### 注意事项
+
+- Commit 的注释信息应该是描述性的
+- 希望读者对审稿人/维护者的评论和意见保持开放的心态，并努力改进代码或文档
+- 新的 PR 不一定会及时审核，取决于审稿人/维护者的当时的工作时间

src/about/contributing/README.md

@@ -0,0 +1,7 @@
+---
+title: 贡献者指南
+index: false
+order: 2
+---
+
+<AutoCatalog />