Skip to content

Update documentation contribution guidelines and code contribution wo… #252

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
jiaoshuntian wants to merge 1 commit into
base: master
Choose a base branch
from
+19 −1
Open

Update documentation contribution guidelines and code contribution wo… #252

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions CN/modules/ROOT/pages/master/contribution/community_contribution_guide.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,6 +93,10 @@ IvorySQL源码托管在github: <https://github.com/IvorySQL>。

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

==== 文档贡献

如果您新增或更新某个插件适配文档，请同步更新 xref:master/ecosystem_components/ecosystem_overview.adoc[ecosystem_overview.adoc] 概述页面中的插件表格，至少补充或更新插件名称、版本、功能描述、适用场景以及详情页链接，确保概述页与插件详情页信息一致。

==== 签署CLA
在提交代码或文档贡献之前，为了确保代码合法合规，个人或企业贡献者需要签署贡献者许可协议(CLA)。签署CLA是IvorySQL社区接受贡献的必要条件，以确保您的贡献被合法分发。请根据下列链接下载CLA进行签署并将签署后的CLA发送至 [email protected]。

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

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

===== Fork仓库

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

请在 PR 标题或描述中显式关联对应 Issue 编号，例如 `Fixes #123` 或 `Refs #123`。

点击Create pull request 按钮即可提交。

=== 维护者
Expand Down
12 changes: 11 additions & 1 deletion EN/modules/ROOT/pages/master/contribution/community_contribution_guide.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,8 @@ You can upload your modified bugs, new functions and other codes to your persona

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.

When you add or update a plugin compatibility document, you must also update the plugin summary table in xref:master/ecosystem_components/ecosystem_overview.adoc[ecosystem_overview.adoc]. 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.

==== Test IvorySQL and Report Bugs

GitHub: https://github.com/IvorySQL/IvorySQL
Expand Down Expand Up @@ -98,7 +100,7 @@ If the change you're working on touches functionality that is common between Pos

==== Patch submission

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.
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.

==== Patch review

Expand Down Expand Up @@ -197,6 +199,8 @@ Click submit new issue button. WELL DONE!

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

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.

=== Second: Clone the warehouse to local

```
Expand Down Expand Up @@ -237,10 +241,14 @@ Git push -u origin new-branch-name

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

3 In the PR title or description, explicitly reference the corresponding Issue number, for example `Fixes #123` or `Refs #123`.

== **Submit PR**

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

Every GitHub PR must have a corresponding Issue. A PR without an associated Issue does not meet the community contribution process requirements.

=== First:Create a Pull Request
Copy link
Copy Markdown
Collaborator

@bigplaice bigplaice Apr 17, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The creation of PR here is duplicated with line 238.


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

Reference the related Issue in the PR description and keep the Issue number visible to reviewers, for example `Fixes #123`.

=== Third:Submit PR

Click Create pull request button. WELL DONE!
Expand Down
Loading