Skip to content

Commit 75a7f1a

Browse files
bochencwxlioncfliu
authored andcommitted
Docs: update CONTRIBUTING
1 parent 97c1cde commit 75a7f1a

2 files changed

Lines changed: 9 additions & 13 deletions

File tree

CONTRIBUTING.md

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,6 @@ This document aims to provide you with a detailed contribution guide to help you
77
Please read this guide carefully before contributing and make sure to follow the rules here.
88
We look forward to working with you to make this project better together!
99

10-
## Becoming a contributor
11-
12-
The first step is registering as a tRPC-Cpp contributor.
13-
Before sending your first change to the tRPC-Cpp project you must have [signed and submitted a CLA (Contributor License Agreement)](to-do).
14-
1510
## Before contributing code
1611

1712
The project welcomes code patches, but to make sure things are well coordinated you should discuss any significant change before starting the work.
@@ -43,12 +38,15 @@ When opening an issue, make sure to answer these five questions:
4338
4. What did you expect to see?
4439
5. What did you see instead?
4540

46-
For change proposals, see Proposing Changes To [tRPC-Proposals](to-do).
41+
For change proposals, see Proposing Changes To [tRPC-Proposals](https://github.com/trpc-group/trpc/blob/main/proposal/README.md).
4742

4843
## Contributing code
4944

5045
Follow the [GitHub flow](https://docs.github.com/en/get-started/quickstart/github-flow) to [create a GitHub pull request](https://docs.github.com/en/get-started/quickstart/github-flow#create-a-pull-request).
5146

47+
If this is your first time submitting a PR to the tRPC project, you will be reminded in the "Conversation" tab of the PR to sign and submit the [Contributor License Agreement](https://github.com/trpc-group/cla-database/blob/main/Tencent-Contributor-License-Agreement.md).
48+
Only when you have signed the Contributor License Agreement, your submitted PR has the possibility of being accepted.
49+
5250
Some things to keep in mind:
5351
- Ensure that your code conforms to the project's code specifications.
5452
This includes but is not limited to code style, comment specifications, etc. This helps us to maintain the cleanliness and consistency of the project.
@@ -105,7 +103,7 @@ When this change is eventually applied, the issue tracker will automatically mar
105103
### Copyright headers
106104

107105
Files in the tRPC-Cpp repository don't list author names, both to avoid clutter and to avoid having to keep the lists up to date.
108-
Instead, your name will appear in the [change log](todo).
106+
Instead, your name will appear in the change log.
109107

110108
New files that you contribute should use the standard copyright header:
111109

CONTRIBUTING.zh_CN.md

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,6 @@
77
在贡献之前,请仔细阅读本指南并确保遵循这里的规则。
88
我们期待与您共同努力,使这个项目变得更好!
99

10-
## 成为贡献者
11-
12-
第一步是注册为 tRPC-Cpp 贡献者。
13-
向 tRPC-Cpp 项目发送您的第一个变更之前,您必须签署并提交[贡献者许可协议](to-do)
14-
1510
## 在贡献代码之前
1611

1712
项目欢迎代码补丁,但为了确保事情得到良好协调,您应该在开始工作之前讨论任何重大变更。
@@ -43,12 +38,15 @@ issue 会被分类以管理工作流程。
4338
4. 您期望看到什么?
4439
5. 您实际看到的是什么?
4540

46-
关于变更提案,请参阅向 [tRPC-Proposals](to-do) 提议变更。
41+
关于变更提案,请参阅向 [tRPC-Proposals](https://github.com/trpc-group/trpc/blob/main/proposal/README.md) 提议变更。
4742

4843
## 贡献代码
4944

5045
遵循 [GitHub 流程](https://docs.github.com/en/get-started/quickstart/github-flow)[创建 GitHub PR(Pull Request)](https://docs.github.com/en/get-started/quickstart/github-flow#create-a-pull-request)
5146

47+
如果你是第一次向 tRPC 项目提交 PR,那么在该 PR 的对话栏中会提醒你签署并提交[贡献者许可协议](https://github.com/trpc-group/cla-database/blob/main/Tencent-Contributor-License-Agreement.md)
48+
只有当你签署过贡献者许可协议,你提交的 PR 才有可能被接受。
49+
5250
请记住以下几点:
5351

5452
- 确保您的代码符合项目的代码规范。

0 commit comments

Comments
 (0)