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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Strict Mode: Verify all comments. #11

Closed
bwplotka opened this issue Sep 15, 2020 · 3 comments
Closed

Strict Mode: Verify all comments. #11

bwplotka opened this issue Sep 15, 2020 · 3 comments

Comments

@bwplotka
Copy link

Hi 馃憢

This is a little but amazing project. Something we really needed in our project to replace our old mad stuff: https://github.com/thanos-io/thanos/blob/55cb8ca38b3539381dc6a781e637df15c694e50a/scripts/build-check-comments.sh#L85

The only missing bit is that we want to a bit more strict. We actually created bit stricter style guide as well. And as per that https://thanos.io/tip/coding-style-guide.md/#comments-should-be-full-sentences we don't want to allow broken comments (without trailing period, but also not started without a capital letter), anywhere in the code. And the reason is simple: We don't want hacky non-readable comments anywhere.

Would you consider some PR with a stricter mode that will ensure all comments validated?

cc @kakkoyun

@tetafro
Copy link
Owner

tetafro commented Sep 16, 2020

Sounds good. The only problem I see is config - there is already a flag --all (for all top-level comments). It would be confusing, if there is another option to check even more (any comment anywhere). I think it would be a right thing to change this behaviour and update package to v2 v1.
If you don't mind I'll do it myself :)

@tetafro
Copy link
Owner

tetafro commented Sep 30, 2020

I've added an option to check all comments in v1.0.1. It's not in golangci-lint yet, but you can try it with godot cli

go get -u github.com/tetafro/godot/cmd/godot
godot --scope all ./myproject

@tetafro
Copy link
Owner

tetafro commented Nov 11, 2020

Sorry for the delay. Everything is done and is in golangci-lint now.

@tetafro tetafro closed this as completed Jun 21, 2021
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

2 participants