Linter - Included linter check for doc rules #148
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
naveensrinivasan
force-pushed
the
naveen/feat/linter-comments
branch
from
9ebbcdb
to
1bc026e
Compare
|
@naveensrinivasan please sign the dco :) |
One of the most annoying things of contributing to sigstore. :) |
Sigstore being a library it helps a lot to follow guidelines on comments. golint has been deprecated and revive is the replacement for golint. https://revive.run/docs ``` # EXC0012 revive: Annoying issue about not having a comment. The rare codebase has such comments - exported (.+) should have comment( \(or a comment on this block\))? or be unexported # EXC0013 revive: Annoying issue about not having a comment. The rare codebase has such comments - package comment should be of the form "(.+)... # EXC0014 revive: Annoying issue about not having a comment. The rare codebase has such comments - comment on exported (.+) should be of the form "(.+)..." # EXC0015 revive: Annoying issue about not having a comment. The rare codebase has such comments - should have a package comment, unless it's in another file for this package ``` Signed-off-by: naveen <172697+naveensrinivasan@users.noreply.github.com>
naveensrinivasan
force-pushed
the
naveen/feat/linter-comments
branch
from
1bc026e
to
b3ac1b2
Compare
cpanato
approved these changes
Nov 17, 2021
bobcallaway
approved these changes
Nov 17, 2021
Closed
mtrmac
pushed a commit
to mtrmac/sigstore
that referenced
this pull request
Mar 10, 2023
In lack of a proper examples field, using ffcli's LongHelp to render some extra fields to make commands more usable. Signed-off-by: Ahmet Alp Balkan <ahmetb@google.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Sigstore being a library it helps a lot to follow guidelines on comments.
golint has been deprecated and revive is the replacement for golint. https://revive.run/docs