Merge pull request #13 from ccoVeille/add-license

feat: add license

and navigation via the README

00-empty/.golangci.yaml

@@ -1,4 +1,8 @@
 ---
+# golangci-lint configuration file made by @ccoVeille
+# Source: https://github.com/ccoVeille/golangci-lint-config-examples/tree/main/00-empty
+# License: MIT
+#
 # empty file to force using the default settings
 # otherwise golangci-lint looks for .golangci.yaml files
 # in parent folders

00-empty/README.md

@@ -5,3 +5,10 @@ One way to use the default settings is to use `--no-config` parameter.
 Another is to create an empty YAML file
 
 See [.golangci.yaml](.golangci.yaml)
+
+## License
+
+License: MIT
+
+golangci-lint configuration file made by @ccoVeille
+Source: https://github.com/ccoVeille/golangci-lint-config-examples/tree/main/00-empty

01-defaults/.golangci.yaml

@@ -1,4 +1,8 @@
 ---
+# golangci-lint configuration file made by @ccoVeille
+# Source: https://github.com/ccoVeille/golangci-lint-config-examples/tree/main/01-defaults
+# License: MIT
+#
 linters:
   # some linters are enabled by default
   # https://golangci-lint.run/usage/linters/

01-defaults/README.md

@@ -4,6 +4,13 @@ These are the currently available linter that are enabled in the current last `g
 
 See [.golangci.yaml](.golangci.yaml)
 
+## License
+
+License: MIT
+
+golangci-lint configuration file made by @ccoVeille
+Source: https://github.com/ccoVeille/golangci-lint-config-examples/tree/main/01-defaults
+
 ## Enabled linters
 
 ### errcheck

02-basics/.golangci.yaml → 02-basic/.golangci.yaml

@@ -1,4 +1,8 @@
 ---
+# golangci-lint configuration file made by @ccoVeille
+# Source: https://github.com/ccoVeille/golangci-lint-config-examples/tree/main/02-basic
+# License: MIT
+#
 linters:
   # some linters are enabled by default
   # https://golangci-lint.run/usage/linters/

02-basics/README.md → 02-basic/README.md

@@ -1,10 +1,17 @@
-# Safe Settings
+# Basic Settings
 
 See [.golangci.yaml](.golangci.yaml)
 
 It's [01-defaults](../01-defaults) plus :
 - [revive](#revive)
 
+## License
+
+License: MIT
+
+golangci-lint configuration file made by @ccoVeille
+Source: https://github.com/ccoVeille/golangci-lint-config-examples/tree/main/02-basics
+
 ## Enabled linters
 
 ### errcheck

03-safe/.golangci.yaml

@@ -1,4 +1,8 @@
 ---
+# golangci-lint configuration file made by @ccoVeille
+# Source: https://github.com/ccoVeille/golangci-lint-config-examples/tree/main/03-safe
+# License: MIT
+#
 linters:
   # some linters are enabled by default
   # https://golangci-lint.run/usage/linters/

03-safe/README.md

@@ -1,15 +1,22 @@
-# Safer Settings
+# Safe Settings
 
 See [.golangci.yaml](.golangci.yaml)
 
-It's [02-basics](../02-basics) plus :
+It's [02-basic](../02-basic) plus :
 - [gci](#gci)
 - [thelper](#thelper)
 - [mirror](#mirror)
 - [usestdlibvars](#usestdlibvars)
 - [dupwords](#dupwords)
 - [misspell](#misspell)
 
+## License
+
+License: MIT
+
+golangci-lint configuration file made by @ccoVeille
+Source: https://github.com/ccoVeille/golangci-lint-config-examples/tree/main/03-safe
+
 ## Enabled linters
 
 ### errcheck

README.md

@@ -1,3 +1,27 @@
 # Configuration examples for golangci-lint
 
 These are `.golangci.yaml` examples to use in your projects
+
+## Variants
+
+- [00-empty](./00-empty)
+- [01-defaults](./01-defaults)
+- [02-basic](./02-basic)
+- [03-safe](./03-safe)
+
+The bigger the number is the more rules it has.
+
+Each variant adds rules to the earlier one.
+
+## License
+
+License: MIT
+
+golangci-lint configuration file made by @ccoVeille
+Source: https://github.com/ccoVeille/golangci-lint-config-examples
+
+## Changelog
+
+- 2024-06-28 - golangci-lint:1.59.1
+
+  initial version