Skip to content

Commit

Permalink
Polish document content in README.md (#542)
Browse files Browse the repository at this point in the history
* Fix wrong spelling in README.md

Fix wrong spelling in README.md

* Polish document content
  • Loading branch information
steverao authored Apr 9, 2024
1 parent 24d4bc0 commit 342e1d4
Showing 1 changed file with 12 additions and 12 deletions.
24 changes: 12 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,16 +52,16 @@ for definition of maturity levels).
Components marked `Stable` provide the following guarantees:

- Field types, numbers and names will not change.
- Service names and service package names will not change.
- Service names and `service` package names will not change.
- Service method names will not change. [from 1.0.0]
- Service method parameter names will not change. [from 1.0.0]
- Service method parameter types and return types will not change. [from 1.0.0]
- Service method kind (unary vs streaming) will not change.
- Names of messages and enums will not change. [from 1.0.0]
- Numbers assigned to enum choices will not change.
- Names of enum choices will not change. [from 1.0.0]
- The location of messages and enums, i.e. whether they are declared at the top lexical
scope or nested inside another message will not change. [from 1.0.0]
- Names of `message`s and `enum`s will not change. [from 1.0.0]
- Numbers assigned to `enum` choices will not change.
- Names of `enum` choices will not change. [from 1.0.0]
- The location of `message`s and `enum`s, i.e. whether they are declared at the top lexical
scope or nested inside another `message` will not change. [from 1.0.0]
- Package names and directory structure will not change. [from 1.0.0]
- `optional` and `repeated` declarators of existing fields will not change. [from 1.0.0]
- No existing symbol will be deleted. [from 1.0.0]
Expand All @@ -71,12 +71,12 @@ with version number 1.0.0.

The following additive changes are allowed:

- Adding new fields to existing messages.
- Adding new messages or enums.
- Adding new choices to existing enums.
- Adding new choices to existing oneof fields.
- Adding new services.
- Adding new methods to existing services.
- Adding new fields to existing `message`s.
- Adding new `message`s or `enum`s.
- Adding new choices to existing `enum`s.
- Adding new choices to existing `oneof` fields.
- Adding new `service`s.
- Adding new `method`s to existing `service`s.

All the additive changes above must be accompanied by an explanation about how
new and old senders and receivers that implement the version of the protocol
Expand Down

0 comments on commit 342e1d4

Please sign in to comment.