summaryrefslogtreecommitdiff
path: root/Documentation/source/zh_CN/contributing.rst
diff options
context:
space:
mode:
authorBertrand Yuan <189593334+bertyuan@users.noreply.github.com>2026-04-27 20:54:16 +0800
committerGitHub <noreply@github.com>2026-04-27 20:54:16 +0800
commit85b6fb59db5fe1112c58eff9d02ae4f9c9b6456d (patch)
tree8c83fc84bd9547630e6733929dec77e102e055a8 /Documentation/source/zh_CN/contributing.rst
parent658798b3a2378bb6df16cfbb16d707c6fb719e1e (diff)
parentdbb5e791f0c228369605d126dd590962ebe1eddc (diff)
Merge pull request #21 from bertyuan/Documentationv1.2
docs: add comprehensive documentation for operations
Diffstat (limited to 'Documentation/source/zh_CN/contributing.rst')
-rw-r--r--Documentation/source/zh_CN/contributing.rst38
1 files changed, 38 insertions, 0 deletions
diff --git a/Documentation/source/zh_CN/contributing.rst b/Documentation/source/zh_CN/contributing.rst
new file mode 100644
index 0000000..cc0b39f
--- /dev/null
+++ b/Documentation/source/zh_CN/contributing.rst
@@ -0,0 +1,38 @@
+贡献指南
+========
+
+工作流程
+--------
+
+1. 先判断变更属于哪个子系统。
+2. 阅读相邻实现和测试。
+3. 确认变更是否影响运行时行为、schema、UI、文档或运维流程。
+4. 保持 patch 聚焦,不做无关重构。
+
+提交信息
+--------
+
+推荐格式:
+
+.. code-block:: text
+
+ <type>(<scope>): <short summary>
+
+常用类型包括 ``build``、``ci``、``docs``、``feat``、``fix``、``perf``、``refactor`` 和 ``test``。摘要使用祈使句、现在时,不以句号结尾。
+
+代码完整性
+----------
+
+* 发布版本时优先使用签名 commit 和签名 tag。
+* 不提交密钥、本地数据库状态或构建产物。
+* 依赖变更应和源代码变更一样认真审查。
+* 非平凡变更应在分支上开发,并通过测试和文档构建。
+
+提交前检查
+----------
+
+.. code-block:: bash
+
+ pnpm lint
+ pnpm test
+ make -C Documentation html