Skip to content

Re-enable COMMENT_FIELD buf lint check #9978

Closed
@amaury1093

Description

Summary

We disabled buf's COMMENT_FIELD, so that some proto fields don't need to have comments. Let's re-enable it.

Problem Definition

We disabled buf's COMMENT_FIELD, so that some proto fields don't need to have comments. But probably it's a good practice to over-comment, than to inadvertently forget some important fields.

ref: #9747 (review)

Proposal

  • Remove ignoing COMMENT_FIELD in buf.yaml linter
  • Audit proto files and add comments everywhere where it's missing
  • Update ADR-044 concerning COMMENT_FIELD

For Admin Use

  • Not duplicate issue
  • Appropriate labels applied
  • Appropriate contributors tagged
  • Contributor assigned/self-assigned

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Assignees

No one assigned

    Labels

    toolingdev tooling within the sdk

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions