diff options
| author | Karthik Nayak <knayak@gitlab.com> | 2023-10-05 13:50:35 +0300 |
|---|---|---|
| committer | Karthik Nayak <knayak@gitlab.com> | 2023-10-05 15:59:08 +0300 |
| commit | 713ae958bd7a4e3518a284c92b252796973a01dd (patch) | |
| tree | e88a6607cb23fe1ad166526b84a2de0fa78b7f51 /proto/.protolint.yaml | |
| parent | 18a42674883493dfb2c4e9a35b784260131468a4 (diff) | |
proto: Add linter rules for comments
Currently we don't have any linting rules for comments in proto files.
This has led to various styled being used in the comments and lack of
consistency. Enforce the styling for comments in proto files.
This commit also includes manual changes to comments in proto files to
adhere to these new rules. The changes are lazy in nature, mostly
minimal changes to simply conform to the new rules. This is to reduce
review load and also writing good comments is out of the purpose of this
commit.
Diffstat (limited to 'proto/.protolint.yaml')
| -rw-r--r-- | proto/.protolint.yaml | 13 |
1 files changed, 13 insertions, 0 deletions
diff --git a/proto/.protolint.yaml b/proto/.protolint.yaml index 334293199..86fc4c228 100644 --- a/proto/.protolint.yaml +++ b/proto/.protolint.yaml @@ -17,3 +17,16 @@ lint: # disable it. - FIELD_NAMES_EXCLUDE_PREPOSITIONS - MESSAGE_NAMES_EXCLUDE_PREPOSITIONS + rules_option: + messages_have_comment: + should_follow_golang_style: true + services_have_comment: + should_follow_golang_style: true + rpcs_have_comment: + should_follow_golang_style: true + fields_have_comment: + should_follow_golang_style: true + enums_have_comment: + should_follow_golang_style: true + enum_fields_have_comment: + should_follow_golang_style: true |