Skip to content

Commit 840e4dd

Browse files
committed
Add build instructions
1 parent 52bdc94 commit 840e4dd

File tree

3 files changed

+48
-13
lines changed

3 files changed

+48
-13
lines changed

BUILDING.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# Building gRPC-Kotlin
2+
3+
Building should only be necessary if you are making changes to gRPC-Kotlin, or if
4+
you'd like to use or test a version of gRPC-Kotlin that hasn't been released
5+
yet.
6+
7+
Use the following gradle command to build gRPC-Kotlin:
8+
9+
```console
10+
$ ./gradlew build
11+
```
12+
13+
Install the built artifacts into your local Maven repository so that you can use
14+
them in your projects:
15+
16+
```console
17+
$ ./gradlew publishToMavenLocal
18+
```
19+
20+
Ensure that you configure your project build to use the local version of
21+
gRPC-Kotlin.

CONTRIBUTING.md

Lines changed: 18 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -18,29 +18,30 @@ Agreement](https://identity.linuxfoundation.org/projects/cncf).
1818
Before starting any development work you will need a local copy of the gRPC repository.
1919

2020
## Guidelines for Pull Requests
21+
2122
How to get your contributions merged smoothly and quickly.
22-
23+
2324
- Create **small PRs** that are narrowly focused on **addressing a single
2425
concern**. We often times receive PRs that are trying to fix several things
2526
at a time, but only one fix is considered acceptable, nothing gets merged and
2627
both author's & review's time is wasted. Create more PRs to address different
2728
concerns and everyone will be happy.
28-
29+
2930
- For speculative changes, consider opening an issue and discussing it first.
3031
If you are suggesting a behavioral or API change, consider starting with a
3132
[gRFC proposal](https://github.com/grpc/proposal).
32-
33+
3334
- Provide a good **PR description** as a record of **what** change is being made
3435
and **why** it was made. Link to a GitHub issue if it exists.
35-
36+
3637
- Don't fix code style and formatting unless you are already changing that line
3738
to address an issue. PRs with irrelevant changes won't be merged. If you do
3839
want to fix formatting or style, do that in a separate PR.
3940

4041
- If you are adding a new file, make sure it has the copyright message template
4142
at the top as a comment. You can copy over the message from an existing file
4243
and update the year.
43-
44+
4445
- Unless your PR is trivial, you should expect there will be reviewer comments
4546
that you'll need to address before merging. We expect you to be reasonably
4647
responsive to those comments, otherwise the PR will be closed after 2-3 weeks
@@ -51,27 +52,31 @@ How to get your contributions merged smoothly and quickly.
5152
Use `rebase -i upstream/master` to curate your commit history and/or to
5253
bring in latest changes from master (but avoid rebasing in the middle of
5354
a code review).
54-
55+
5556
- Keep your PR up to date with upstream/master (if there are merge conflicts,
5657
we can't really merge your change).
57-
58+
5859
- **All tests need to be passing** before your change can be merged.
5960
We recommend you **run tests locally** before creating your PR to catch
6061
breakages early on (see `src/test`)
61-
62+
6263
- Exceptions to the rules can be made if there's a compelling reason for doing
6364
so.
6465

6566
## Obtaining Commit Access
67+
6668
We grant Commit Access to contributors based on the following criteria:
69+
6770
* Sustained contribution to the gRPC project.
68-
* Deep understanding of the areas contributed to, and good consideration of various reliability, usability and performance tradeoffs.
69-
* Contributions demonstrate that obtaining Commit Access will significantly reduce friction for the contributors or others.
71+
* Deep understanding of the areas contributed to, and good consideration of various reliability, usability and performance tradeoffs.
72+
* Contributions demonstrate that obtaining Commit Access will significantly reduce friction for the contributors or others.
7073

7174
In addition to submitting PRs, a Contributor with Commit Access can:
75+
7276
* Review PRs and merge once other checks and criteria pass.
73-
* Triage bugs and PRs and assign appropriate labels and reviewers.
77+
* Triage bugs and PRs and assign appropriate labels and reviewers.
78+
79+
### Obtaining Commit Access without Code Contributions
7480

75-
### Obtaining Commit Access without Code Contributions
76-
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.
81+
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.
7782

README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,13 @@ For more information, see the following [Kotlin pages from grpc.io][]:
3333
- [gRPC Basics - Kotlin/JVM][] tutorial
3434
- [API Reference][]
3535

36+
How-to pages from this repo:
37+
38+
- [Contributing](CONTRIBUTING.md)
39+
- [Building gRPC-Kotlin](BUILDING.md)
40+
41+
Note that [official releases][] are [published to Maven Central][].
42+
3643
[API Reference]: https://grpc.io/docs/languages/kotlin/api
3744
[Gradle Build Status]: https://github.com/grpc/grpc-kotlin/workflows/Gradle%20Build/badge.svg
3845
[Bazel Build Status]: https://github.com/grpc/grpc-kotlin/workflows/Bazel%20Build/badge.svg
@@ -46,5 +53,7 @@ For more information, see the following [Kotlin pages from grpc.io][]:
4653
[maven:plugin]: https://search.maven.org/search?q=g:%22io.grpc%22%20AND%20a:%22protoc-gen-grpc-kotlin%22
4754
[maven:stub]: https://search.maven.org/search?q=g:%22io.grpc%22%20AND%20a:%22grpc-kotlin-stub%22
4855
[maven:stub-lite]: https://search.maven.org/search?q=g:%22io.grpc%22%20AND%20a:%22grpc-kotlin-stub-lite%22
56+
[official releases]: https://github.com/grpc/grpc-kotlin/releases
4957
[protoc]: https://github.com/protocolbuffers/protobuf#protocol-compiler-installation
5058
[protocolbuffers/protobuf#3742]: https://github.com/protocolbuffers/protobuf/issues/3742
59+
[published to Maven Central]: https://search.maven.org/search?q=g:io.grpc%20AND%20grpc-kotlin

0 commit comments

Comments
 (0)