Conversation
shivaspeaks
left a comment
shivaspeaks
left a comment
There was a problem hiding this comment.
I'm not sure what you're trying to fix in the readme, but the changes doesn't seem to be better than existing.
If you really want to contribute to grpc, there are other (more significant) ways you can contribute. Check with the issues and from there you can pick any good first issue or bug.
README.md
Outdated
| a [plugin](https://github.com/google/grpc-java/blob/master/compiler) to the | ||
| protocol-buffers compiler that generates Stub interfaces out of `.proto` files, | ||
| but bindings to other datamodel/IDL are easy and encouraged. | ||
| but bindings to other data models or IDLs are supported and encouraged. |
There was a problem hiding this comment.
I don't see it as an improvement.
We also have:
The Stub layer is what is exposed to most developers and provides type-safe
bindings to whatever datamodel/IDL/interface you are adapting.
Using both 'datamodel' (no space) and 'data models' (with space) in the same paragraph is confusing. Since this is a minor stylistic change that doesn't address the broken links elsewhere, I don't think this makes it any better.
README.md
Outdated
| -------- | ||
|
|
||
| Download [the JARs][]. Or for Maven with non-Android, add to your `pom.xml`: | ||
| Download [the JARs]: https://search.maven.org/search?q=g:io.grpc%20AND%20v:1.79.0. Or for Maven with non-Android, add to your `pom.xml`: |
There was a problem hiding this comment.
We prefer to keep markdown here, reference definitions should be on their own line (typically at the end of the file) or formatted as an inline link: [the JARs](https://...).
README.md
Outdated
|
|
||
| Supported Platforms | ||
| ------------------- | ||
| ## Supported Platforms |
There was a problem hiding this comment.
I'd ask to revert this as well.
README.md
Outdated
| | Resource | Link | | ||
| |--------|------| | ||
| | Homepage | https://grpc.io | | ||
| | Mailing List | grpc-io@googlegroups.com | |
There was a problem hiding this comment.
We would like to keep clickable links. Your update changes these to plain text, which makes it harder for users to navigate to those resources.
Thank you for the feedback @shivaspeaks |
2 participants
Fix broken reference link in README.md
Changes: