Update contributor doc for update release note when submit new pr (#3…

…3049)
apache · Sep 29, 2024 · 6805e48 · 6805e48
1 parent ec7ce3b
commit 6805e48
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 4 deletions.
diff --git a/RELEASE-NOTES.md b/RELEASE-NOTES.md
@@ -6,11 +6,11 @@
 
 ### Enhancement
 
-1. SQL Parser: Support PostgreSQL, openGauss function table and update from segment parse - #32994
+1. SQL Parser: Support PostgreSQL, openGauss function table and update from segment parse - [#32994](https://github.com/apache/shardingsphere/pull/32994)
 
 ### Bug Fix
 
-1. Sharding: Fix alter view exception when config sharding rule and binding table rule - #32696
+1. Sharding: Fix alter view exception when config sharding rule and binding table rule - [#32696](https://github.com/apache/shardingsphere/issues/32696)
 
 ### Change Log
 

diff --git a/docs/community/content/involved/contribute/contributor.cn.md b/docs/community/content/involved/contribute/contributor.cn.md
@@ -82,7 +82,11 @@ git push origin issueNo
  - 接着导师做 CodeReview，然后他会与您讨论一些细节（包括设计，实现，性能等）。当导师对本次修改满意后，会将提交合并到当前开发版本的分支中。
  - 最后，恭喜您已经成为了 ShardingSphere 的官方贡献者！
 
-**6. 删除分支**
+**6. 更新 Release Note**
+
+ - 编码完成后，请更新当前开发版本的 [Release Note](https://github.com/apache/shardingsphere/blob/master/RELEASE-NOTES.md)，根据 issue 的不同类型，在 `API Change`、`New Feature`、`Enhancement` 或 `Bug Fix` 分类中进行添加，`RELEASE-NOTES` 需要遵循统一的格式：`{feature_name}: {description} - {issue/pr link}`，例如：`SQL Parser: Support PostgreSQL, openGauss function table and update from segment parse - #32994`。
+
+**7. 删除分支**
 
  - 在导师将 pull request 合并到 ShardingSphere 的 master 分支中之后，您就可以将远程的分支（origin/issueNo）及与远程分支（origin/issueNo）关联的本地分支（issueNo）删除。
 

diff --git a/docs/community/content/involved/contribute/contributor.en.md b/docs/community/content/involved/contribute/contributor.en.md
@@ -82,7 +82,11 @@ git push origin issueNo
  - The mentor will do code review before discussing some details (including the design, the implementation and the performance) with you. The request will be merged into the branch of current development version after the edit is well enough.
  - At last, congratulations on being an official contributor of ShardingSphere
 
-**6. Delete Branch**
+**6. Update Release Note**
+
+ - After coding is completed, please update the [Release Note](https://github.com/apache/shardingsphere/blob/master/RELEASE-NOTES.md) of current development version. According to the different types of issues, add them in the `API Change`, `New Feature`, `Enhancement` or `Bug Fix` categories. `RELEASE-NOTES` needs to follow the unified format: `{feature_name}: {description} - {issue/pr link}`, for example: `SQL Parser: Support PostgreSQL, openGauss function table and update from segment parse - #32994`.
+
+**7. Delete Branch**
 
  - You can delete the remote branch (origin/issueNo) and the local branch (issueNo) associated with the remote branch (origin/issueNo) after the mentor merged the pull request into the master branch of ShardingSphere.