Skip to content

Commit

Permalink
Docs: update CONTRIBUTING
Browse files Browse the repository at this point in the history
  • Loading branch information
bochencwx authored and lioncfliu committed Oct 17, 2023
1 parent 97c1cde commit 75a7f1a
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 13 deletions.
12 changes: 5 additions & 7 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,6 @@ This document aims to provide you with a detailed contribution guide to help you
Please read this guide carefully before contributing and make sure to follow the rules here.
We look forward to working with you to make this project better together!

## Becoming a contributor

The first step is registering as a tRPC-Cpp contributor.
Before sending your first change to the tRPC-Cpp project you must have [signed and submitted a CLA (Contributor License Agreement)](to-do).

## Before contributing code

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

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

## Contributing code

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).

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).
Only when you have signed the Contributor License Agreement, your submitted PR has the possibility of being accepted.

Some things to keep in mind:
- Ensure that your code conforms to the project's code specifications.
This includes but is not limited to code style, comment specifications, etc. This helps us to maintain the cleanliness and consistency of the project.
Expand Down Expand Up @@ -105,7 +103,7 @@ When this change is eventually applied, the issue tracker will automatically mar
### Copyright headers

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.
Instead, your name will appear in the [change log](todo).
Instead, your name will appear in the change log.

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

Expand Down
10 changes: 4 additions & 6 deletions CONTRIBUTING.zh_CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,6 @@
在贡献之前,请仔细阅读本指南并确保遵循这里的规则。
我们期待与您共同努力,使这个项目变得更好!

## 成为贡献者

第一步是注册为 tRPC-Cpp 贡献者。
向 tRPC-Cpp 项目发送您的第一个变更之前,您必须签署并提交[贡献者许可协议](to-do)

## 在贡献代码之前

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

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

## 贡献代码

遵循 [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)

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

请记住以下几点:

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

0 comments on commit 75a7f1a

Please sign in to comment.