Skip to content

Commit 4dfc90a

Browse files
committed
docs: remove contribution methods and collaboration process from guide
These sections will be displayed on the official website only. The documentation site contribution guide now focuses on: - Roles and responsibilities - Getting started (GitHub account, CLA) - Code contributions - Ecosystem component adaptation - Remove '贡献方式' section from Chinese version - Remove '社区协作流程' section from Chinese version - Remove 'Ways to Contribute' section from English version - Remove 'Community Collaboration Process' section from English version
1 parent 87c3e4b commit 4dfc90a

2 files changed

Lines changed: 0 additions & 106 deletions

File tree

CN/modules/ROOT/pages/master/contribution/contribution_guide.adoc

Lines changed: 0 additions & 53 deletions
Original file line numberDiff line numberDiff line change
@@ -7,59 +7,6 @@
77

88
IvorySQL 的成长离不开来自世界各地的开发者、测试人员、文档作者、翻译者、社区布道师和用户的贡献。本指南将帮助您了解如何参与 IvorySQL 社区,从入门到深入贡献的完整路径。
99

10-
== 贡献方式
11-
12-
IvorySQL 社区相信开源应当触手可及,每一份贡献都弥足珍贵。您可以根据自己的背景和兴趣选择参与方式:
13-
14-
* *代码贡献*:内核开发、功能迭代、Bug 修复、插件开发、生态工具适配、回归测试、代码评审
15-
* *非代码贡献*:Issue 反馈、文档改进、技术翻译、社区问答、线上线下分享、案例研究、迁移经验分享、社区推广
16-
17-
如果您还不确定如何开始,也可以通过复现问题、澄清需求、改进文档或在社区讨论中帮助其他用户来做出有意义的贡献。
18-
19-
== 社区协作流程
20-
21-
IvorySQL 社区采用一套闭环式开源协作流程,确保从问题提出到版本发布,每一个环节都能闭合反馈、持续改进。这一流程鼓励用户与开发者形成良性互动,让社区开发始终围绕实际需求持续演进。
22-
23-
整个协作闭环流程如下:
24-
25-
🐛 *提问题(Issue)*
26-
27-
用户或开发者在 GitHub 的 Issues 页面提交 Bug、功能建议或使用反馈。
28-
29-
💬 *问题讨论(Discussion)*
30-
31-
维护者与社区成员就问题展开讨论,确认问题性质与优先级,加入 ToDo List。
32-
33-
🛠️ *开发分支(Fork & Dev)*
34-
35-
开发者认领 Issue,Fork 仓库并在本地开发测试,准备提交代码。
36-
37-
🚀 *提交 Pull Request(PR)*
38-
39-
将开发分支 Push 到 Fork 仓库后,向上游仓库发起合并请求。
40-
41-
🧐 *代码评审(Review)*
42-
43-
维护者或核心开发者对 PR 进行评审,提出修改建议并确保质量。
44-
45-
🔀 *合并主分支(Merge)*
46-
47-
审核通过后,PR 被合并至主分支,对应的 Issue 被关闭。
48-
49-
📦 *版本发布(Release)*
50-
51-
项目定期发布新版本(每季度小版本,每年大版本),包含最新的修复与功能。
52-
53-
🧪 *用户测试(Test)*
54-
55-
用户升级使用新版,反馈新问题,新的 Issue 随之产生,形成完整的反馈循环。
56-
57-
image::p23.jpg[]
58-
59-
通过这套完整的闭环协作机制,IvorySQL 实现了问题响应 → 开发贡献 → 质量保障 → 发布反馈的全流程闭合,推动项目持续健康演进。
60-
61-
📢 请务必阅读并遵守我们的 https://github.com/IvorySQL/IvorySQL/blob/master/CODE_OF_CONDUCT_CN.md[IvorySQL社区行为准则]。
62-
6310
== 角色与职责
6411

6512
在参与贡献前,请确认您当前的参与身份,以便更高效地了解适合您的贡献方式:

EN/modules/ROOT/pages/master/contribution/contribution_guide.adoc

Lines changed: 0 additions & 53 deletions
Original file line numberDiff line numberDiff line change
@@ -7,59 +7,6 @@
77

88
IvorySQL grows through contributions from developers, testers, documentation writers, translators, community advocates, and users around the world. This guide will help you understand how to participate in the IvorySQL community, from getting started to making in-depth contributions.
99

10-
== Ways to Contribute
11-
12-
The IvorySQL community believes that open source should be approachable and that no contribution is too small. You can participate in a way that matches your background and interests:
13-
14-
* *Code contributions*: kernel development, feature iteration, bug fixes, plugin development, ecosystem tool adaptation, regression tests, and code review.
15-
* *Non-code contributions*: issue reports, documentation improvements, technical translation, community Q&A, online or offline talks, case studies, migration experience sharing, and community promotion.
16-
17-
If you are not ready to submit code yet, you can still make a meaningful contribution by reproducing issues, clarifying requirements, improving docs, or helping other users in community discussions.
18-
19-
== Community Collaboration Process
20-
21-
The IvorySQL community employs a closed-loop open-source collaboration process, ensuring that every step—from issue submission to version release—receives closed feedback and continuous improvement. This process encourages良性互动 between users and developers, allowing community development to evolve around actual needs.
22-
23-
The entire closed-loop collaboration process is as follows:
24-
25-
🐛 *Submit Issue*
26-
27-
Users or developers submit bugs, feature suggestions, or usage feedback on the GitHub Issues page.
28-
29-
💬 *Discussion*
30-
31-
Maintainers and community members discuss the issue, confirm its nature and priority, and add it to the ToDo List.
32-
33-
🛠️ *Development Branch (Fork & Dev)*
34-
35-
Developers claim the Issue, fork the repository, develop and test locally, and prepare to submit code.
36-
37-
🚀 *Submit Pull Request (PR)*
38-
39-
Push the development branch to the forked repository and initiate a merge request to the upstream repository.
40-
41-
🧐 *Code Review*
42-
43-
Maintainers or core developers review the PR, provide modification suggestions, and ensure quality.
44-
45-
🔀 *Merge to Main Branch*
46-
47-
After approval, the PR is merged into the main branch, and the corresponding Issue is closed.
48-
49-
📦 *Release*
50-
51-
The project regularly releases new versions (minor versions quarterly, major versions annually), including the latest fixes and features.
52-
53-
🧪 *User Testing*
54-
55-
Users upgrade to the new version, provide feedback on new issues, and new Issues are generated, forming a complete feedback loop.
56-
57-
image::p23.jpg[]
58-
59-
Through this complete closed-loop collaboration mechanism, IvorySQL achieves full-process closure of issue response → development contribution → quality assurance → release feedback, promoting the continuous healthy evolution of the project.
60-
61-
📢 Please read and abide by our https://github.com/IvorySQL/IvorySQL/blob/master/CODE_OF_CONDUCT_CN.md[IvorySQL Community Code of Conduct].
62-
6310
== Roles and Responsibilities
6411

6512
Before contributing, please confirm your current participation role to more efficiently understand the contribution methods suitable for you:

0 commit comments

Comments
 (0)