go.mod: vendor golangci-lint

1 files changed, 54 insertions, 0 deletions

diff --git a/vendor/github.com/tetafro/godot/README.md b/vendor/github.com/tetafro/godot/README.md
new file mode 100644
index 000000000..e2d2f6b0d
--- /dev/null
+++ b/vendor/github.com/tetafro/godot/README.md
@@ -0,0 +1,54 @@
+# godot
+
+[![License](http://img.shields.io/badge/license-MIT-green.svg?style=flat)](https://raw.githubusercontent.com/tetafro/godot/master/LICENSE)
+[![Github CI](https://img.shields.io/github/workflow/status/tetafro/godot/Test)](https://github.com/tetafro/godot/actions?query=workflow%3ATest)
+[![Go Report](https://goreportcard.com/badge/github.com/tetafro/godot)](https://goreportcard.com/report/github.com/tetafro/godot)
+[![Codecov](https://codecov.io/gh/tetafro/godot/branch/master/graph/badge.svg)](https://codecov.io/gh/tetafro/godot)
+
+Linter that checks if all top-level comments contain a period at the
+end of the last sentence if needed.
+
+[CodeReviewComments](https://github.com/golang/go/wiki/CodeReviewComments#comment-sentences) quote:
+
+> Comments should begin with the name of the thing being described
+> and end in a period
+
+## Install and run
+
+*NOTE: Godot is available as a part of [GolangCI Lint](https://github.com/golangci/golangci-lint)
+(disabled by default).*
+
+Build from source
+```sh
+go get -u github.com/tetafro/godot/cmd/godot
+```
+
+or download binary from [releases page](https://github.com/tetafro/godot/releases).
+
+Run
+```sh
+godot ./myproject
+```
+
+## Examples
+
+Code
+
+```go
+package math
+
+// Sum sums two integers
+func Sum(a, b int) int {
+    return a + b // result
+}
+```
+
+Output
+
+```sh
+Top level comment should end in a period: math/math.go:3:1
+```
+
+See more examples in test files:
+- [for default mode](testdata/example_default.go)
+- [for using --all flag](testdata/example_checkall.go)