Skip to content

Commit 8e4c66f

Browse files
committed
docs: extract common Issue claiming process to general contribution workflow
Add a new '认领 Issue' (Claim an Issue) section to the '通用贡献流程' (Common Contribution Process) chapter that describes the general process applicable to all contribution types: - Browse Issue list and search for relevant Issues - Confirm Issue is not already assigned - Claim unassigned Issues using 'Assign yourself' - Create new Issues when needed - Wait for maintainer confirmation before starting work Simplify the '认领或新建 Issue' (Claim or Create Issue) section in the '组件适配贡献' (Component Adaptation Contribution) chapter to reference the general process and only keep component-specific requirements: - Issue type: Feature Request - Label: extension - Title format: Ecosystem Integration: <component name> - Body format: one sentence describing the component and its purpose This reduces content duplication and makes the general Issue claiming process clearer for all types of contributions.
1 parent e515f28 commit 8e4c66f

2 files changed

Lines changed: 58 additions & 30 deletions

File tree

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

Lines changed: 29 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -118,13 +118,29 @@ IvorySQL 源码托管在 GitHub:<https://github.com/IvorySQL>。
118118

119119
未签署 CLA 的 Pull Request 将无法进入评审阶段。
120120

121-
[TIP]
121+
122+
== **通用贡献流程**
123+
122124
提交 Issue 和提交 PR 是所有类型贡献(代码贡献、文档贡献、组件适配贡献)的公共流程。无论您参与哪种类型的贡献,都需要遵循这两个步骤。
123125

124126

125-
== **提交Issue**
127+
=== 认领 Issue
128+
129+
在开始贡献之前,您需要在目标仓库的 Issue 列表中找到或创建一个 Issue:
130+
131+
. 浏览仓库的 Issue 列表,搜索与您想要贡献的内容相关的 Issue
132+
. 如果找到相关 Issue,确认其尚未被分配(Assignees 为空)
133+
. 如果 Issue 未被分配,点击右上角 Assignees 区域的 `Assign yourself`,将 Issue 认领给自己
134+
. 如果 Issue 已被他人认领,请选择其他 Issue 或与认领者协商
135+
. 如果没有找到相关 Issue,新建一个 Issue,描述您想要贡献的内容,并分配给自己
136+
. 等待维护者评估和确认,在获得维护者确认后再开始贡献工作
137+
138+
[TIP]
139+
建议在 Issue 获得维护者确认后再开始工作,避免重复或无效工作。
140+
141+
=== 提交Issue
126142

127-
=== 进入New issue 页面:
143+
==== 进入New issue 页面:
128144

129145
1、进入 IvorySql官网:https://github.com/IvorySQL/IvorySQL
130146

@@ -133,7 +149,7 @@ IvorySQL 源码托管在 GitHub:<https://github.com/IvorySQL>。
133149
image::p3.png[]
134150

135151

136-
=== 选择需要填写的issue类型
152+
==== 选择需要填写的issue类型
137153

138154
**1、bug report**
139155

@@ -192,22 +208,22 @@ Title: 标题
192208
```
193209

194210

195-
=== 提交
211+
==== 提交
196212

197213
点击 submit new issue 按钮, 提交即可
198214

199-
== **提交PR**
215+
=== 提交PR
200216

201217
对于提交一个PR应该保持一个功能,或者一个bug提交一次。禁止多个功能一次提交。
202218

203219

204-
=== 创建一个Pull Request
220+
==== 创建一个Pull Request
205221

206222
1、打开你 Fork 的仓库(将 $user 替换为你的 GitHub ID)。
207223

208224
2、点击 Compare & pull request 按钮
209225

210-
=== 填写PR信息
226+
==== 填写PR信息
211227

212228
```
213229
Fix test
@@ -219,7 +235,7 @@ leave a comment
219235
对该提交功能进行比较详细的描述
220236
```
221237

222-
=== 提交PR
238+
==== 提交PR
223239

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

@@ -383,16 +399,14 @@ IvorySQL 作为一款基于 PostgreSQL 研发的 Oracle 兼容数据库,天然
383399

384400
===== 认领或新建 Issue
385401

386-
在 IvorySQL 仓库的 https://github.com/IvorySQL/IvorySQL/issues[Issue 列表] 中搜索目标组件
402+
按照 xref:#_认领_issue[认领 Issue] 章节的步骤认领或新建 Issue,并注意以下组件适配特有的要求
387403

388-
- 如果相关适配 Issue 已存在,先确认其尚未被分配(Assignees 为空),然后点击右上角 Assignees 区域的 `Assign yourself`,将该 Issue 认领给自己;若已被他人认领,请重新选择组件;
389-
- 如果相关 Issue 尚不存在,则新建一个 `Feature Request` 类型的 Issue,添加 `extension` 标签,并分配给自己。新建 Issue 的格式可参考已有的生态组件适配类 Issue:标题格式为 `Ecosystem Integration: <组件名>`,正文用一句话说明要适配的组件及其用途。
404+
- 新建 Issue 时,选择 `Feature Request` 类型,添加 `extension` 标签
405+
- 标题格式:`Ecosystem Integration: <组件名>`
406+
- 正文用一句话说明要适配的组件及其用途
390407

391408
维护者会评估该组件是否适合纳入 IvorySQL 生态,并在 Issue 中与您沟通确认。
392409

393-
[TIP]
394-
建议在 Issue 获得维护者确认后再开始适配工作,避免重复或无效工作。
395-
396410
==== 适配测试
397411

398412
生态组件适配的目标分为两个层面:

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

Lines changed: 29 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -118,13 +118,29 @@ If you contribute via the AtomGit platform, the system will automatically assist
118118

119119
Pull Requests from contributors who have not signed the CLA will not be able to enter the review stage.
120120

121-
[TIP]
121+
122+
== **Common Contribution Process**
123+
122124
Submitting Issues and submitting PRs are common processes for all types of contributions (code contributions, documentation contributions, component adaptation contributions). Regardless of which type of contribution you participate in, you need to follow these two steps.
123125

124126

125-
== **Submit Issue**
127+
=== Claim an Issue
128+
129+
Before starting your contribution, you need to find or create an Issue in the target repository:
130+
131+
. Browse the repository's Issue list and search for Issues related to what you want to contribute
132+
. If you find a relevant Issue, confirm that it has not been assigned (Assignees is empty)
133+
. If the Issue is unassigned, click `Assign yourself` in the Assignees area in the upper right corner to claim the Issue for yourself
134+
. If the Issue has already been claimed by someone else, please choose another Issue or negotiate with the claimant
135+
. If no relevant Issue is found, create a new Issue describing what you want to contribute and assign it to yourself
136+
. Wait for maintainer evaluation and confirmation, and start your contribution work only after receiving maintainer confirmation
137+
138+
[TIP]
139+
It is recommended to start working only after the Issue is confirmed by maintainers to avoid duplicate or invalid work.
126140

127-
=== Enter New issue page:
141+
=== Submit Issue
142+
143+
==== Enter New issue page:
128144

129145
1. Go to IvorySQL official website: https://github.com/IvorySQL/IvorySQL
130146

@@ -133,7 +149,7 @@ Submitting Issues and submitting PRs are common processes for all types of contr
133149
image::p3.png[]
134150

135151

136-
=== Select the issue type to fill in
152+
==== Select the issue type to fill in
137153

138154
**1. bug report**
139155

@@ -192,22 +208,22 @@ Describe a feature you expect to be implemented
192208
```
193209

194210

195-
=== Submit
211+
==== Submit
196212

197213
Click the submit new issue button to submit
198214

199-
== **Submit PR**
215+
=== Submit PR
200216

201217
For submitting a PR, you should keep one feature or one bug per submission. Submitting multiple features at once is prohibited.
202218

203219

204-
=== Create a Pull Request
220+
==== Create a Pull Request
205221

206222
1. Open your Forked repository (replace $user with your GitHub ID).
207223

208224
2. Click Compare & pull request button
209225

210-
=== Fill in PR information
226+
==== Fill in PR information
211227

212228
```
213229
Fix test
@@ -219,7 +235,7 @@ leave a comment
219235
Provide a more detailed description of the submitted function
220236
```
221237

222-
=== Submit PR
238+
==== Submit PR
223239

224240
Click the Create pull request button to submit.
225241

@@ -383,16 +399,14 @@ Before starting the adaptation work, please first check the xref:master/ecosyste
383399

384400
===== Claim or Create Issue
385401

386-
Search for the target component in the https://github.com/IvorySQL/IvorySQL/issues[Issue list] of the IvorySQL repository:
402+
Follow the steps in the xref:#_claim_an_issue[Claim an Issue] section to claim or create an Issue, and note the following component adaptation-specific requirements:
387403

388-
- If the relevant adaptation Issue already exists, first confirm that it has not been assigned (Assignees is empty), then click `Assign yourself` in the Assignees area in the upper right corner to claim this Issue for yourself; if it has already been claimed by others, please reselect the component;
389-
- If the relevant Issue does not exist yet, create a new `Feature Request` type Issue, add the `extension` label, and assign it to yourself. The format for creating a new Issue can refer to existing ecosystem component adaptation Issues: the title format is `Ecosystem Integration: <component name>`, and the body uses one sentence to explain the component to be adapted and its purpose.
404+
- When creating a new Issue, select the `Feature Request` type and add the `extension` label
405+
- Title format: `Ecosystem Integration: <component name>`
406+
- Use one sentence in the body to explain the component to be adapted and its purpose
390407

391408
Maintainers will evaluate whether the component is suitable for inclusion in the IvorySQL ecosystem and communicate with you in the Issue for confirmation.
392409

393-
[TIP]
394-
It is recommended to start the adaptation work after the Issue is confirmed by maintainers to avoid duplicate or invalid work.
395-
396410
==== Adaptation Testing
397411

398412
The goals of ecosystem component adaptation are divided into two levels:

0 commit comments

Comments
 (0)