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.

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

Docs for generated code visibility best practice #20061

Open
kriswuollett opened this issue Jan 21, 2025 · 0 comments
Open

Docs for generated code visibility best practice #20061

kriswuollett opened this issue Jan 21, 2025 · 0 comments

Comments

@kriswuollett
Copy link

I believe most of the protobuf code generators follow the published best practices published on https://protobuf.dev/. Some examples are:

That's great. However, I somewhat recall a "Readability" issue in general that protos should not to be used for types within core application logic directly, i.e. protos should ideally be used for serialization only? I think such guidance is missing from the docs, and that could have the impact of unnecessary library/semver coupling showing up in open source libraries as more developers adopt gRPC/(Protobuf/FlatBuffer/etc.)? If included in the docs it could also help with the backward/forward compatibility mindset.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant