Skip to content

Commit baf2b4c

Browse files
authored
optimize: update contributing doc (apache#6181)
1 parent de9596b commit baf2b4c

File tree

4 files changed

+31
-29
lines changed

4 files changed

+31
-29
lines changed

CONTRIBUTING.md

+15-15
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# Contributing to Seata
1+
# Contributing to Apache Seata(incubating)
22

3-
It is warmly welcomed if you have interest to hack on Seata. First, we encourage this kind of willing very much. And here is a list of contributing guide for you.
3+
It is warmly welcomed if you have interest to hack on Apache Seata(incubating). First, we encourage this kind of willing very much. And here is a list of contributing guide for you.
44

55
[[中文贡献文档](./CONTRIBUTING_CN.md)]
66

@@ -15,11 +15,11 @@ It is warmly welcomed if you have interest to hack on Seata. First, we encourage
1515

1616
## Reporting security issues
1717

18-
Security issues are always treated seriously. As our usual principle, we discourage anyone to spread security issues. If you find a security issue of Seata, please do not discuss it in public and even do not open a public issue. Instead we encourage you to send us a private email to [[email protected]](mailto:[email protected]) to report this.
18+
Security issues are always treated seriously. As our usual principle, we discourage anyone to spread security issues. If you find a security issue of Apache Seata(incubating), please do not discuss it in public and even do not open a public issue. Instead we encourage you to send us a private email to [[email protected]](mailto:[email protected]) to report this.
1919

2020
## Reporting general issues
2121

22-
To be honest, we regard every user of Seata as a very kind contributor. After experiencing Seata, you may have some feedback for the project. Then feel free to open an issue via [NEW ISSUE](https://github.com/seata/seata/issues/new/choose).
22+
To be honest, we regard every user of Seata as a very kind contributor. After experiencing Seata, you may have some feedback for the project. Then feel free to open an issue via [NEW ISSUE](https://github.com/apache/incubator-seata/issues/new/choose).
2323

2424
Since we collaborate project Seata in a distributed way, we appreciate **WELL-WRITTEN**, **DETAILED**, **EXPLICIT** issue reports. To make the communication more efficient, we wish everyone could search if your issue is an existing one in the searching list. If you find it existing, please add your details in comments under the existing issue instead of opening a brand new one.
2525

@@ -70,36 +70,36 @@ Since you are ready to improve Seata with a PR, we suggest you could take a look
7070

7171
To put forward a PR, we assume you have registered a GitHub ID. Then you could finish the preparation in the following steps:
7272

73-
1. **FORK** Seata to your repository. To make this work, you just need to click the button Fork in right-left of [seata/seata](https://github.com/seata/seata) main page. Then you will end up with your repository in `https://github.com/<your-username>/seata`, in which `your-username` is your GitHub username.
73+
1. **FORK** Seata to your repository. To make this work, you just need to click the button Fork in right-left of [apache/incubator-seata](https://github.com/apache/incubator-seata) main page. Then you will end up with your repository in `https://github.com/<your-username>/incubator-seata`, in which `your-username` is your GitHub username.
7474

75-
1. **CLONE** your own repository to develop locally. Use `git clone [email protected]:<your-username>/seata.git` to clone repository to your local machine. Then you can create new branches to finish the change you wish to make.
75+
1. **CLONE** your own repository to develop locally. Use `git clone [email protected]:<your-username>/incubator-seata.git` to clone repository to your local machine. Then you can create new branches to finish the change you wish to make.
7676

77-
1. **Set Remote** upstream to be `[email protected]:seata/seata.git` using the following two commands:
77+
1. **Set Remote** upstream to be `[email protected]:apache/incubator-seata.git` using the following two commands:
7878

7979
```bash
80-
git remote add upstream [email protected]:seata/seata.git
80+
git remote add upstream [email protected]:apache/incubator-seata.git
8181
git remote set-url --push upstream no-pushing
8282
```
8383

8484
With this remote setting, you can check your git remote configuration like this:
8585

8686
```shell
8787
$ git remote -v
88-
origin [email protected]:<your-username>/seata.git (fetch)
89-
origin [email protected]:<your-username>/seata.git (push)
90-
upstream [email protected]:seata/seata.git (fetch)
88+
origin [email protected]:<your-username>/incubator-seata.git (fetch)
89+
origin [email protected]:<your-username>/incubator-seata.git (push)
90+
upstream [email protected]:apache/incubator-seata.git (fetch)
9191
upstream no-pushing (push)
9292
```
9393

9494
Adding this, we can easily synchronize local branches with upstream branches.
9595

9696
### Branch Definition
9797

98-
Right now we assume every contribution via pull request is for [branch develop](https://github.com/seata/seata/tree/develop) in Seata. Before contributing, be aware of branch definition would help a lot.
98+
Right now we assume every contribution via pull request is for [branch develop](https://github.com/apache/incubator-seata/tree/2.x) in Seata. Before contributing, be aware of branch definition would help a lot.
9999

100100
As a contributor, keep in mind again that every contribution via pull request is for branch develop. While in project Seata, there are several other branches, we generally call them release branches(such as 0.6.0,0.6.1), feature branches, hotfix branches and master branch.
101101

102-
When officially releasing a version, there will be a release branch and named with the version number.
102+
When officially releasing a version, there will be a release branch and named with the version number.
103103

104104
After the release, we will merge the commit of the release branch into the master branch.
105105

@@ -186,7 +186,7 @@ Seata code style Comply with Alibaba Java Coding Guidelines.
186186

187187

188188
### Guidelines
189-
[Alibaba-Java-Coding-Guidelines](https://alibaba.github.io/Alibaba-Java-Coding-Guidelines/)
189+
[Alibaba-Java-Coding-Guidelines](https://alibaba.github.io/Alibaba-Java-Coding-Guidelines/)
190190

191191

192192
### IDE Plugin Install(not necessary)
@@ -195,7 +195,7 @@ Seata code style Comply with Alibaba Java Coding Guidelines.
195195

196196

197197
#### idea IDE
198-
[p3c-idea-plugin-install](https://github.com/alibaba/p3c/blob/master/idea-plugin/README.md)
198+
[p3c-idea-plugin-install](https://github.com/alibaba/p3c/blob/master/idea-plugin/README.md)
199199

200200
#### eclipse IDE
201201
[p3c-eclipse-plugin-install](https://github.com/alibaba/p3c/blob/master/eclipse-plugin/README.md)

CONTRIBUTING_CN.md

+14-14
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# 为 Seata 做贡献
1+
# Apache Seata(incubating) 做贡献
22

3-
如果你有兴趣寻找关于Seata的漏洞,我们会热烈欢迎。首先,我们非常鼓励这种意愿。这是为您提供的贡献指南列表。
3+
如果你有兴趣寻找关于Apache Seata(incubating)的漏洞,我们会热烈欢迎。首先,我们非常鼓励这种意愿。这是为您提供的贡献指南列表。
44

55
[[English Contributing Document](./CONTRIBUTING.md)]
66

@@ -15,11 +15,11 @@
1515

1616
## 报告安全问题
1717

18-
安全问题总会认真对待。通常,我们不鼓励任何人传播安全问题。如果您发现Seata的安全问题,请不要公开讨论,甚至不要公开问题。相反,我们鼓励您向 [[email protected]](mailto:[email protected]) 发送私人电子邮件 以报告此情况。
18+
安全问题总会认真对待。通常,我们不鼓励任何人传播安全问题。如果您发现Apache Seata(incubating)的安全问题,请不要公开讨论,甚至不要公开问题。相反,我们鼓励您向 [[email protected]](mailto:[email protected]) 发送私人电子邮件 以报告此情况。
1919

2020
## 报告一般问题
2121

22-
老实说,我们认为每一个 Seata 用户都是非常好的贡献者。在体验了 Seata 之后,您可能会对项目有一些反馈。那么随时可以通过 [NEW ISSUE](https://github.com/seata/seata/issues/new/choose) 来提交。
22+
老实说,我们认为每一个 Seata 用户都是非常好的贡献者。在体验了 Seata 之后,您可能会对项目有一些反馈。那么随时可以通过 [NEW ISSUE](https://github.com/apache/incubator-seata/issues/new/choose) 来提交。
2323

2424
由于我们通过分布式方式协作Seata,我们欣赏高质量,详细的,准确的问题报告。为了让沟通更高效,我们希望每个人都可以搜索下您的问题是否在搜索列表中。如果您发现它存在,请在现有问题评论中添加您的详细信息,而不是打开一个全新的问题。
2525

@@ -70,40 +70,40 @@
7070

7171
为了提出 PR,我们假设你已经注册了一个 GitHub ID。然后您可以通过以下步骤完成准备工作:
7272

73-
1. **FORK** Seata 到您的仓库。要完成这项工作,您只需单击 [seata/seata](https://github.com/seata/seata) 主页右侧的 Fork 按钮。然后你将得到以你的仓库为路径的项目地址:`https://github.com/<your-username>/seata`,其中your-username是你的 GitHub 用户名。
73+
1. **FORK** Seata 到您的仓库。要完成这项工作,您只需单击 [apache/incubator-seata](https://github.com/apache/incubator-seata) 主页右侧的 Fork 按钮。然后你将得到以你的仓库为路径的项目地址:`https://github.com/<your-username>/incubator-seata`,其中your-username是你的 GitHub 用户名。
7474

75-
2. **克隆** 您自己的存储库以在本地开发. 使用 `git clone [email protected]:<your-username>/seata.git` 将存储库克隆到本地计算机。 然后您可以创建新分支来完成您希望进行的更改。
75+
2. **克隆** 您自己的存储库以在本地开发. 使用 `git clone [email protected]:<your-username>/incubator-seata.git` 将存储库克隆到本地计算机。 然后您可以创建新分支来完成您希望进行的更改。
7676

77-
3. **设置远程** 将上游设置为 `[email protected]:seata/seata.git` 使用以下两个命令:
77+
3. **设置远程** 将上游设置为 `[email protected]:apache/incubator-seata.git` 使用以下两个命令:
7878

7979
```bash
80-
git remote add upstream [email protected]:seata/seata.git
80+
git remote add upstream [email protected]:apache/incubator-seata.git
8181
git remote set-url --push upstream no-pushing
8282
```
8383

8484
使用此远程设置,您可以像这样检查您的 git 远程配置:
8585

8686
```shell
8787
$ git remote -v
88-
origin [email protected]:<your-username>/seata.git (fetch)
89-
origin [email protected]:<your-username>/seata.git (push)
90-
upstream [email protected]:seata/seata.git (fetch)
88+
origin [email protected]:<your-username>/incubator-seata.git (fetch)
89+
origin [email protected]:<your-username>/incubator-seata.git (push)
90+
upstream [email protected]:apache/incubator-seata.git (fetch)
9191
upstream no-pushing (push)
9292
```
9393

9494
添加这个,我们可以轻松地将本地分支与上游分支同步。
9595

9696
### 分支定义
9797

98-
现在我们假设通过拉取请求的每个贡献都是针对Seata 中的 [开发分支](https://github.com/seata/seata/tree/develop) 。在贡献之前,请注意分支定义会很有帮助。
98+
现在我们假设通过拉取请求的每个贡献都是针对Seata 中的 [开发分支](https://github.com/apache/incubator-seata/tree/2.x) 。在贡献之前,请注意分支定义会很有帮助。
9999

100100
作为贡献者,请再次记住,通过拉取请求的每个贡献都是针对分支开发的。而在Seata项目中,还有其他几个分支,我们一般称它们为release分支(如0.6.0、0.6.1)、feature分支、hotfix分支和master分支。
101101

102102
当正式发布一个版本时,会有一个发布分支并以版本号命名。
103103

104104
在发布之后,我们会将发布分支的提交合并到主分支中。
105105

106-
当我们发现某个版本有bug时,我们会决定在以后的版本中修复它,或者在特定的hotfix版本中修复它。当我们决定修复hotfix版本时,我们会根据对应的release分支checkout hotfix分支,进行代码修复和验证,合并到develop分支和master分支
106+
当我们发现某个版本有bug时,我们会决定在以后的版本中修复它,或者在特定的hotfix版本中修复它。当我们决定修复hotfix版本时,我们会根据对应的release分支checkout hotfix分支,进行代码修复和验证,合并到开发分支和master分支
107107

108108
对于较大的功能,我们将拉出功能分支进行开发和验证。
109109

@@ -195,7 +195,7 @@ Seata 代码风格 符合阿里巴巴 Java 编码指南。
195195

196196

197197
#### idea IDE
198-
[p3c-idea-plugin-install](https://github.com/alibaba/p3c/blob/master/idea-plugin/README.md)
198+
[p3c-idea-plugin-install](https://github.com/alibaba/p3c/blob/master/idea-plugin/README.md)
199199

200200
#### eclipse IDE
201201
[p3c-eclipse-plugin-install](https://github.com/alibaba/p3c/blob/master/eclipse-plugin/README.md)

changes/en-us/2.x.md

+1
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@ Add changes here for all PR submitted to the 2.x branch.
2727
- [[#6145](https://github.com/seata/seata/pull/6145)] upgrade jettison to 1.5.4
2828
- [[#6164](https://github.com/seata/seata/pull/6164)] redis registry push empty protection optimize
2929
- [[#6174](https://github.com/seata/seata/pull/6174)] add ASF basic config
30+
- [[#6181](https://github.com/seata/seata/pull/6181)] update contributing doc
3031
- [[#6179](https://github.com/seata/seata/pull/6179)] remove @author info
3132
- [[#6176](https://github.com/seata/seata/pull/6176)] update source header
3233

changes/zh-cn/2.x.md

+1
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@
2626
- [[#6116](https://github.com/seata/seata/pull/6034)] 移除 lgtm.com
2727
- [[#6164](https://github.com/seata/seata/pull/6164)] redis 注册中心推空保护优化
2828
- [[#6174](https://github.com/seata/seata/pull/6174)] 增加 ASF 基础配置
29+
- [[#6181](https://github.com/seata/seata/pull/6181)] 更新贡献指引文档
2930
- [[#6179](https://github.com/seata/seata/pull/6179)] 移除 @author 信息
3031
- [[#6176](https://github.com/seata/seata/pull/6176)] 更新源文件header信息
3132

0 commit comments

Comments
 (0)