Skip to content

Commit 515ff3f

Browse files
author
Jayant Kolhe
committed
Create CONTRIBUTING.md
1 parent 6865f9c commit 515ff3f

File tree

1 file changed

+24
-0
lines changed

1 file changed

+24
-0
lines changed

CONTRIBUTING.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# How to contribute
2+
3+
This is a place for various components in the gRPC ecosystem that aren't part of the gRPC core. We welcome contributions in this repo which either build extensions around gRPC or showcase how to use gRPC in various use cases and/or with other technologies.
4+
Here is some guideline and information about how to do so.
5+
6+
7+
## Getting started
8+
9+
### Legal requirements
10+
11+
In order to protect both you and ourselves, you will need to sign the
12+
[Contributor License Agreement](https://cla.developers.google.com/clas).
13+
14+
### Guidelines to contribute
15+
16+
Each contribution needs to have a) top level readme explaining what the contribution does, how to use it with gRPC, how to build and test it and what are its external technical dependencies.
17+
Have at least a top level readme.md describing overview, how to use, dependencies, and how to build and test.
18+
Third party libraries: Note that no third party libraries with AGPL license etc should not be used in the codebases.
19+
Automated tests - will have a badge called “Verified” for tested contributions. Contributors should have automated tests present in every contribution and they should run on commit. We (gRPC team) will set up travis CI to facilitate this. Tests must return green before we merge them.
20+
21+
### How contributions will be accepted?
22+
23+
gRPC core team members will accept PRs and merge. Code reviews will be done on a best effort basis. It is however expected that the community will address the comments from core team members. As long as contribution meets the two above mentioned guidelines and CLA is signed, PRs will be merged. The team will try and take care of outstanding requests weekly (ie during office hours). If people want a faster dev cycle, we'd recommend doing this in a fork, per github flow anyways.
24+

0 commit comments

Comments
 (0)