Merge pull request #21 from mineiros-io/fix-documentation

Rename .golangci.yml.example to .golangci.example.yml and update documentation in README.md
mineiros-io · Jul 13, 2020 · 911a366 · 911a366
2 parents ec318fd + f4950e1
commit 911a366
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 5 deletions.
diff --git a/.golangci.yml.example → .golangci.example.yml b/.golangci.yml.example → .golangci.example.yml
diff --git a/README.md b/README.md
@@ -67,8 +67,8 @@ Currently, the following hooks are supported:
 
 ### Markdown
 
-- [markdown-link-check](https://github.com/tcort/markdown-link-check): Checks that all of the hyperlinks in a markdown
-  text to determine if they are alive or dead.
+- [markdown-link-check](https://github.com/tcort/markdown-link-check): Validates that all hyperlinks in a markdown
+  text alive or dead.
 
 ### Bash
 
@@ -104,13 +104,18 @@ repos:
       - id: terraform-fmt
       - id: terraform-validate
       - id: tflint
-      - id: gofmt
-      - id: goimports
-      - id: golint
       - id: golangci-lint
       - id: phony-targets
       - id: markdown-link-check
       - id: shellcheck
+
+      # The following hooks are redundant when golangci-lint is being. Our recommendation is to use golangci-lint
+      # as the main linter for go since it enables you to run all available linters in parallel.
+      # For details please see the example configuration https://github.com/mineiros-io/pre-commit-hooks/blob/master/.golangci.example.yml
+      # - id: gofmt
+      # - id: goimports
+      # - id: golint
+
 ```
 
 Once you created the configuration file inside your repository, you must run `pre-commit install` to activate the hooks.