Skip to content

Commit

Permalink
docs: improve CONTRIBUTING docs (#4163)
Browse files Browse the repository at this point in the history
  • Loading branch information
iportman committed Dec 1, 2021
1 parent f901e08 commit c60cb5e
Show file tree
Hide file tree
Showing 4 changed files with 22 additions and 6 deletions.
12 changes: 9 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,14 +76,14 @@ To put forward a PR, we assume you have registered a GitHub ID. Then you could f

1. **Set Remote** upstream to be `git@github.com:seata/seata.git` using the following two commands:

```
```bash
git remote add upstream git@github.com:seata/seata.git
git remote set-url --push upstream no-pushing
```

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

```
```shell
$ git remote -v
origin git@github.com:<your-username>/seata.git (fetch)
origin git@github.com:<your-username>/seata.git (push)
Expand Down Expand Up @@ -140,7 +140,13 @@ Commit content represents all content changes included in one commit. We had bet

* avoid very large change in a commit;
* complete and reviewable for each commit.
* check git config(`user.name`, `user.email`) when committing to ensure that it is associated with your github ID.
* check git config(`user.name`, `user.email`) when committing to ensure that it is associated with your GitHub ID.

```bash
git config --get user.name
git config --get user.email
```

* when submitting pr, please add a brief description of the current changes to the X.X.X.md file under the 'changes/' folder


Expand Down
12 changes: 9 additions & 3 deletions CONTRIBUTING_CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,14 +76,14 @@

3. **设置远程** 将上游设置为 `git@github.com:seata/seata.git` 使用以下两个命令:

```
```bash
git remote add upstream git@github.com:seata/seata.git
git remote set-url --push upstream no-pushing
```

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

```
```shell
$ git remote -v
origin git@github.com:<your-username>/seata.git (fetch)
origin git@github.com:<your-username>/seata.git (push)
Expand Down Expand Up @@ -140,7 +140,13 @@ upstream no-pushing (push)

* 避免在提交中进行非常大的更改;
* 每次提交都完整且可审查。
* 提交时检查 git config(`user.name`, `user.email`) 以确保它与您的 github ID 相关联。
* 提交时检查 git config(`user.name`, `user.email`) 以确保它与您的 GitHub ID 相关联。

```bash
git config --get user.name
git config --get user.email
```

* 提交pr时,请在'changes/'文件夹下的XXXmd文件中添加当前更改的简要说明


Expand Down
2 changes: 2 additions & 0 deletions changes/1.5.0.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,7 @@ Seata 是一款开源的分布式事务解决方案,提供高性能和简单


### optimize:
- [[#4163](https://github.com/seata/seata/pull/4163)] 完善开发者奉献文档
- [[#3678](https://github.com/seata/seata/pull/3678)] 补充遗漏的配置及新版本pr登记md文件
- [[#3654](https://github.com/seata/seata/pull/3654)] 修正拼写,applicationContex -> applicationContext
- [[#3615](https://github.com/seata/seata/pull/3615)] 二阶段同步提交时,全局事务记录异步删除
Expand Down Expand Up @@ -171,6 +172,7 @@ Seata 是一款开源的分布式事务解决方案,提供高性能和简单
- [wfnuser](https://github.com/wfnuser)
- [siyu](https://github.com/Pinocchio2018)
- [xujj](https://github.com/XBNGit)
- [portman](https://github.com/iportman)

同时,我们收到了社区反馈的很多有价值的issue和建议,非常感谢大家。

Expand Down
2 changes: 2 additions & 0 deletions changes/en-us/1.5.0.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,7 @@


### optimize:
- [[#4163](https://github.com/seata/seata/pull/4163)] improve CONTRIBUTING docs
- [[#3678](https://github.com/seata/seata/pull/3678)] supplement missing configuration and new version documents
- [[#3654](https://github.com/seata/seata/pull/3654)] fix typo,applicationContex -> applicationContext
- [[#3615](https://github.com/seata/seata/pull/3615)] asynchronous deletion after the transaction is committed
Expand Down Expand Up @@ -168,6 +169,7 @@
- [wfnuser](https://github.com/wfnuser)
- [siyu](https://github.com/Pinocchio2018)
- [xujj](https://github.com/XBNGit)
- [portman](https://github.com/iportman)

Also, we receive many valuable issues, questions and advices from our community. Thanks for you all.

Expand Down

0 comments on commit c60cb5e

Please sign in to comment.