Skip to content

Commit 4a11a1f

Browse files
committed
Update documentation contribution guidelines and code contribution workflow
1 parent 823ac9e commit 4a11a1f

File tree

3 files changed

+22
-2
lines changed

3 files changed

+22
-2
lines changed

CN/modules/ROOT/pages/23.adoc

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,8 @@ IvorySQL是在GitHub上开发的,任何希望对其作出贡献的人都必须
6666

6767
IvorySQL社区提供的是中英文文档。英文文档保存在...文档存储库中,中文文档保存在i18n文档存储库中。您可以为任一文档存储库做出贡献。
6868

69+
如果您新增或更新某个插件适配文档,请同步更新 xref:./5.0.adoc[IvorySQL生态插件适配列表] 概述页面中的插件表格,至少补充或更新插件名称、版本、功能描述、适用场景以及详情页链接,确保概述页与插件详情页信息一致。
70+
6971
==== 测试IvorySQL和报告问题
7072

7173
GitHub: https://github.com/IvorySQL/IvorySQL
@@ -106,7 +108,7 @@ IvorySQL官网下载:https://github.com/IvorySQL/Ivory-www
106108

107109
==== 补丁提交
108110

109-
一旦您准备好与IvorySQL核心团队和IvorySQL社区的其他成员共享您的工作,您应该将所有提交推送到从官方IvorySQL派生的您自己的存储库中,并向我们发送请求
111+
一旦您准备好与IvorySQL核心团队和IvorySQL社区的其他成员共享您的工作,请先创建或认领对应的 GitHub Issue,然后将所有提交推送到从官方IvorySQL派生的您自己的存储库中,并向我们发送 Pull Request。所有 PR 都必须至少对应一个 Issue,用于关联需求、缺陷、讨论、评审和合并结果
110112

111113
==== 补丁审查
112114

CN/modules/ROOT/pages/8.1.adoc

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -93,6 +93,10 @@ IvorySQL源码托管在github: <https://github.com/IvorySQL>。
9393

9494
我们欢迎代码、文档、测试等各类贡献。
9595

96+
==== 文档贡献
97+
98+
如果您新增或更新某个插件适配文档,请同步更新 xref:./5.0.adoc[IvorySQL生态插件适配列表] 概述页面中的插件表格,至少补充或更新插件名称、版本、功能描述、适用场景以及详情页链接,确保概述页与插件详情页信息一致。
99+
96100
==== 签署CLA
97101
在提交代码或文档贡献之前,为了确保代码合法合规,个人或企业贡献者需要签署贡献者许可协议(CLA)。签署CLA是IvorySQL社区接受贡献的必要条件,以确保您的贡献被合法分发。请根据下列链接下载CLA进行签署并将签署后的CLA发送至 cla@ivorysql.org。
98102

@@ -125,6 +129,8 @@ IvorySQL源码托管在github: <https://github.com/IvorySQL>。
125129
==== 开发与提交Pull Request
126130
对于提交一个PR应该保持一个功能,或者一个bug提交一次。禁止多个功能一次提交。
127131

132+
提交 GitHub PR 之前,请先创建或认领对应的 Issue。所有 PR 都必须有至少一个对应的 Issue,用于关联需求、缺陷、讨论、评审和合并结果;没有对应 Issue 的 PR 不符合社区贡献流程。
133+
128134
===== Fork仓库
129135

130136
前往项目主页,点击Fork按钮,将IvorySQL项目Fork到您自己的GitHub账户中。
@@ -154,6 +160,8 @@ leave a comment
154160
对该提交功能进行比较详细的描述
155161
```
156162

163+
请在 PR 标题或描述中显式关联对应 Issue 编号,例如 `Fixes #123` 或 `Refs #123`。
164+
157165
点击Create pull request 按钮即可提交。
158166

159167
=== 维护者

EN/modules/ROOT/pages/8.adoc

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,8 @@ You can upload your modified bugs, new functions and other codes to your persona
6060

6161
The IvorySQL community provides Chinese and English documents. English documents are saved in ... document repository, Chinese documents are saved in i18n document repository. You can contribute to one of them or both.
6262

63+
When you add or update a plugin compatibility document, you must also update the plugin summary table in xref:./5.0.adoc[IvorySQL Ecosystem Plugin Compatibility List]. Keep the plugin name, version, function description, use cases, and link to the detail page in sync so that the overview page and the detail page stay consistent.
64+
6365
==== Test IvorySQL and Report Bugs
6466

6567
GitHub: https://github.com/IvorySQL/IvorySQL
@@ -102,7 +104,7 @@ If the change you're working on touches functionality that is common between Pos
102104

103105
==== Patch submission
104106

105-
Once you are ready to share your work with the IvorySQL core team and the rest of the IvorySQL community, you should push all the commits to a branch in your own repository forked from the official IvorySQL and send us a pull request.
107+
Once you are ready to share your work with the IvorySQL core team and the rest of the IvorySQL community, you should first create or claim the corresponding GitHub Issue, then push all the commits to a branch in your own repository forked from the official IvorySQL and send us a pull request. Every pull request must correspond to at least one Issue so that the change request, discussion, review, and merge result remain traceable.
106108

107109
==== Patch review
108110

@@ -201,6 +203,8 @@ Click submit new issue button. WELL DONE!
201203

202204
2 Click the fork button in the upper right corner, Wait for the fork to finish
203205

206+
Before you start coding or editing documents, make sure there is a corresponding GitHub Issue for the change. You can create a new Issue or claim an existing one, but do not submit a PR without an associated Issue.
207+
204208
=== Second: Clone the warehouse to local
205209

206210
```
@@ -241,10 +245,14 @@ Git push -u origin new-branch-name
241245

242246
2 Click Compare & pull request button and create a PR.
243247

248+
3 In the PR title or description, explicitly reference the corresponding Issue number, for example `Fixes #123` or `Refs #123`.
249+
244250
== **Submit PR**
245251

246252
A PR submission should contain only one function or one bug. Prohibit submitting multiple functions at one time.
247253

254+
Every GitHub PR must have a corresponding Issue. A PR without an associated Issue does not meet the community contribution process requirements.
255+
248256
=== First:Create a Pull Request
249257

250258
1 Open your warehouse: https://github.com/$user/docs-cn[https://github.com/$user/IvorySQL] ($user is your GitHub ID) 。
@@ -263,6 +271,8 @@ leave a comment
263271
Give a detailed description of the submission function
264272
```
265273

274+
Reference the related Issue in the PR description and keep the Issue number visible to reviewers, for example `Fixes #123`.
275+
266276
=== Third:Submit PR
267277

268278
Click Create pull request button. WELL DONE!

0 commit comments

Comments
 (0)