-
Notifications
You must be signed in to change notification settings - Fork 23
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* add compliance files * Minor changes * Update AUTHORS --------- Co-authored-by: Sergii Tkachenko <[email protected]>
- Loading branch information
1 parent
7f4696e
commit 7938d15
Showing
6 changed files
with
707 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
Google Inc. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
## Community Code of Conduct | ||
|
||
gRPC follows the [CNCF Code of Conduct](https://github.com/cncf/foundation/blob/master/code-of-conduct.md). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,79 @@ | ||
# How to contribute | ||
|
||
We definitely welcome your patches and contributions to gRPC! Please read the gRPC | ||
organization's [governance rules](https://github.com/grpc/grpc-community/blob/master/governance.md) | ||
and [contribution guidelines](https://github.com/grpc/grpc-community/blob/master/CONTRIBUTING.md) before proceeding. | ||
|
||
If you are new to github, please start by reading [Pull Request | ||
howto](https://help.github.com/articles/about-pull-requests/) | ||
|
||
## Legal requirements | ||
|
||
In order to protect both you and ourselves, you will need to sign the | ||
[Contributor License | ||
Agreement](https://identity.linuxfoundation.org/projects/cncf). | ||
|
||
## Cloning the repository | ||
|
||
Before starting any development work you will need a local copy of the gRPC repository. | ||
|
||
## Guidelines for Pull Requests | ||
How to get your contributions merged smoothly and quickly. | ||
|
||
- Create **small PRs** that are narrowly focused on **addressing a single | ||
concern**. We often times receive PRs that are trying to fix several things | ||
at a time, but only one fix is considered acceptable, nothing gets merged and | ||
both author's & review's time is wasted. Create more PRs to address different | ||
concerns and everyone will be happy. | ||
|
||
- For speculative changes, consider opening an issue and discussing it first. | ||
|
||
- Provide a good **PR description** as a record of **what** change is being made | ||
and **why** it was made. Link to a GitHub issue if it exists. | ||
|
||
- Don't fix code style and formatting unless you are already changing that line | ||
to address an issue. PRs with irrelevant changes won't be merged. If you do | ||
want to fix formatting or style, do that in a separate PR. | ||
|
||
- If you are adding a new file, make sure it has the copyright message template | ||
at the top as a comment. You can copy over the message from an existing file | ||
and update the year. | ||
|
||
- Unless your PR is trivial, you should expect there will be reviewer comments | ||
that you'll need to address before merging. We expect you to be reasonably | ||
responsive to those comments, otherwise the PR will be closed after 2-3 weeks | ||
of inactivity. | ||
|
||
- If you have non-trivial contributions, please consider adding an entry to [the | ||
AUTHORS file](https://github.com/grpc/psm-interop/blob/main/AUTHORS) listing the | ||
copyright holder for the contribution (yourself, if you are signing the | ||
individual CLA, or your company, for corporate CLAs) in the same PR as your | ||
contribution. This needs to be done only once, for each company, or | ||
individual. Please keep this file in alphabetical order. | ||
|
||
- Maintain **clean commit history** and use **meaningful commit messages**. | ||
PRs with messy commit history are difficult to review and won't be merged. | ||
Use `rebase -i upstream/main` to curate your commit history and/or to | ||
bring in latest changes from main (but avoid rebasing in the middle of | ||
a code review). | ||
|
||
- Keep your PR up to date with upstream/main (if there are merge conflicts, | ||
we can't really merge your change). | ||
|
||
- **All tests need to be passing** before your change can be merged. | ||
|
||
- Exceptions to the rules can be made if there's a compelling reason for doing | ||
so. | ||
|
||
## Obtaining Commit Access | ||
We grant Commit Access to contributors based on the following criteria: | ||
* Sustained contribution to the gRPC project. | ||
* Deep understanding of the areas contributed to, and good consideration of various reliability, usability and performance tradeoffs. | ||
* Contributions demonstrate that obtaining Commit Access will significantly reduce friction for the contributors or others. | ||
|
||
In addition to submitting PRs, a Contributor with Commit Access can: | ||
* Review PRs and merge once other checks and criteria pass. | ||
* Triage bugs and PRs and assign appropriate labels and reviewers. | ||
|
||
### Obtaining Commit Access without Code Contributions | ||
The [gRPC organization](https://github.com/grpc) is comprised of multiple repositories and commit access is usually restricted to one or more of these repositories. Some repositories such as the [grpc.github.io](https://github.com/grpc/grpc.github.io/) do not have code, but the same principle of sustained, high quality contributions, with a good understanding of the fundamentals, apply. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
This repository is governed by the gRPC organization's [governance rules](https://github.com/grpc/grpc-community/blob/master/governance.md). |
Oops, something went wrong.