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

prototool linter: require comments in protobuf files #2722

Closed
andrewrynhard opened this issue Nov 3, 2020 · 6 comments
Closed

prototool linter: require comments in protobuf files #2722

andrewrynhard opened this issue Nov 3, 2020 · 6 comments
Labels
Stale

Comments

@andrewrynhard
Copy link
Member

Bug Report

Description

We have protobufs that are barely documented. The prototool linter could help us and require comments.
@AlekSi
Copy link
Contributor

AlekSi commented Jun 16, 2021

I think we also should run prototool format

@smira
Copy link
Member

smira commented Oct 22, 2021

In this task: only enable linters which require minimal fixes, create follow-up tasks for other linters.

@AlekSi AlekSi self-assigned this Nov 1, 2021
AlekSi added a commit to AlekSi/talos that referenced this issue Nov 23, 2021
@AlekSi @smira
chore: format .proto files
322c145 
Refs siderolabs#2722.

Co-authored-by: Andrey Smirnov <andrey.smirnov@talos-systems.com>
@AlekSi AlekSi mentioned this issue Nov 23, 2021
Merged
AlekSi added a commit to AlekSi/talos that referenced this issue Nov 23, 2021
@AlekSi @smira
chore: format .proto files
4fce7b6 
Refs siderolabs#2722.

Co-authored-by: Andrey Smirnov <andrey.smirnov@talos-systems.com>
AlekSi added a commit to AlekSi/talos that referenced this issue Nov 23, 2021
@AlekSi @smira
chore: format .proto files
20d39c0 
Refs siderolabs#2722.

Co-authored-by: Andrey Smirnov <andrey.smirnov@talos-systems.com>
Signed-off-by: Alexey Palazhchenko <alexey.palazhchenko@talos-systems.com>
@AlekSi AlekSi removed their assignment Nov 30, 2021
@AlekSi
Copy link
Contributor

AlekSi commented Nov 30, 2021

I think that one is done, but someone should create follow-up issues

@smira smira changed the title Enable more linters in prototool prototool linter: require comments in protobuf files Mar 16, 2022
@smira
Copy link
Member

smira commented Mar 16, 2022

  • we need to add documentation to the .proto files
  • we need to add a linter which will require all future APIs to be properly documented

@github-actions GitHub Actions
Copy link

github-actions bot commented Jul 4, 2024

This issue is stale because it has been open 180 days with no activity. Remove stale label or comment or this will be closed in 7 days.

@github-actions github-actions bot added the Stale label Jul 4, 2024
@github-actions GitHub Actions
Copy link

This issue was closed because it has been stalled for 7 days with no activity.

@github-actions github-actions bot closed this as not planned Won't fix, can't repro, duplicate, stale Jul 11, 2024
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Sep 9, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
Stale
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@AlekSi @smira @andrewrynhard