Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: Add proto deletion ban to style guide #6565

Closed
wants to merge 1 commit into from
Closed

docs: Add proto deletion ban to style guide #6565

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions STYLE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,3 +55,13 @@ Exception when omitting repeated types for consecutive arguments:
short and related arguments (e.g. `start, end int64`) should either go on the same line
or the type should be repeated on each line -- no argument should appear by itself
on a line with no type (confusing and brittle when edited).

## Protobuf IDLs
See Google's [suggested rules](https://developers.google.com/protocol-buffers/docs/proto#updating)
when modifying protos, namely:
* Never change the type in place
* Never simply delete a field -- always replace it with a `reserved ID`
* As an alternative to replacing a field with `reserved`, prefixing the name with `OBSOLETE_`
can be used to signal deprecation (while still allowing printing in debugging, etc).
When doing so, it is safe to change the type of an embedded message to `bytes`,
allowing the message definition to be deleted.