From a4822a1d9885541e3723cb8b9cd405f4030ef3c0 Mon Sep 17 00:00:00 2001 From: ccoVeille <3875889+ccoVeille@users.noreply.github.com> Date: Sat, 29 Jun 2024 17:48:57 +0200 Subject: [PATCH 1/3] fix: markdown links due to rename --- 00-empty/README.md | 2 +- 01-defaults/README.md | 2 +- 02-basic/README.md | 2 +- 03-safe/README.md | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/00-empty/README.md b/00-empty/README.md index c279a3f..45a66fc 100644 --- a/00-empty/README.md +++ b/00-empty/README.md @@ -4,7 +4,7 @@ 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) +See [.golangci.yml](.golangci.yml) ## License diff --git a/01-defaults/README.md b/01-defaults/README.md index 3931986..53e419b 100644 --- a/01-defaults/README.md +++ b/01-defaults/README.md @@ -2,7 +2,7 @@ These are the currently available linter that are enabled in the current last `golangci-lint` version available today (1.59.1) -See [.golangci.yaml](.golangci.yaml) +See [.golangci.yml](.golangci.yml) ## License diff --git a/02-basic/README.md b/02-basic/README.md index 0cdf0f7..3f6dc1b 100644 --- a/02-basic/README.md +++ b/02-basic/README.md @@ -1,6 +1,6 @@ # Basic Settings -See [.golangci.yaml](.golangci.yaml) +See [.golangci.yml](.golangci.yml) It's [01-defaults](../01-defaults) plus : - [revive](#revive) diff --git a/03-safe/README.md b/03-safe/README.md index c395cee..d520e5e 100644 --- a/03-safe/README.md +++ b/03-safe/README.md @@ -1,6 +1,6 @@ # Safe Settings -See [.golangci.yaml](.golangci.yaml) +See [.golangci.yml](.golangci.yml) It's [02-basic](../02-basic) plus : - [gci](#gci) From 0a0da7af3382adc8472f518e5b72d7789053b63b Mon Sep 17 00:00:00 2001 From: ccoVeille <3875889+ccoVeille@users.noreply.github.com> Date: Sat, 29 Jun 2024 18:16:29 +0200 Subject: [PATCH 2/3] fix: license information are clearer --- 00-empty/.golangci.yml | 5 ++++- 00-empty/README.md | 4 ++-- 01-defaults/.golangci.yml | 5 ++++- 01-defaults/README.md | 3 +-- 02-basic/.golangci.yml | 5 ++++- 03-safe/.golangci.yml | 5 ++++- 03-safe/README.md | 3 +-- README.md | 9 ++------- 8 files changed, 22 insertions(+), 17 deletions(-) diff --git a/00-empty/.golangci.yml b/00-empty/.golangci.yml index 7f25495..2fb0fc5 100644 --- a/00-empty/.golangci.yml +++ b/00-empty/.golangci.yml @@ -1,7 +1,10 @@ --- # golangci-lint configuration file made by @ccoVeille -# Source: https://github.com/ccoVeille/golangci-lint-config-examples/tree/main/00-empty +# Source: https://github.com/ccoVeille/golangci-lint-config-examples/ +# Author: @ccoVeille # License: MIT +# Variant: 01-defaults +# Version: v1.0.0 # # empty file to force using the default settings # otherwise golangci-lint looks for .golangci.yaml files diff --git a/00-empty/README.md b/00-empty/README.md index 45a66fc..8ca3697 100644 --- a/00-empty/README.md +++ b/00-empty/README.md @@ -10,5 +10,5 @@ See [.golangci.yml](.golangci.yml) License: MIT -golangci-lint configuration file made by @ccoVeille -Source: https://github.com/ccoVeille/golangci-lint-config-examples/tree/main/00-empty +Source: [@ccoVeille](https://github.com/ccoVeille/golangci-lint-config-examples) + diff --git a/01-defaults/.golangci.yml b/01-defaults/.golangci.yml index 534eab8..4ac56e3 100644 --- a/01-defaults/.golangci.yml +++ b/01-defaults/.golangci.yml @@ -1,7 +1,10 @@ --- # golangci-lint configuration file made by @ccoVeille -# Source: https://github.com/ccoVeille/golangci-lint-config-examples/tree/main/01-defaults +# Source: https://github.com/ccoVeille/golangci-lint-config-examples/ +# Author: @ccoVeille # License: MIT +# Variant: 01-defaults +# Version: v1.0.0 # linters: # some linters are enabled by default diff --git a/01-defaults/README.md b/01-defaults/README.md index 53e419b..31366aa 100644 --- a/01-defaults/README.md +++ b/01-defaults/README.md @@ -8,8 +8,7 @@ See [.golangci.yml](.golangci.yml) License: MIT -golangci-lint configuration file made by @ccoVeille -Source: https://github.com/ccoVeille/golangci-lint-config-examples/tree/main/01-defaults +Source: [@ccoVeille](https://github.com/ccoVeille/golangci-lint-config-examples) ## Enabled linters diff --git a/02-basic/.golangci.yml b/02-basic/.golangci.yml index 18a6f1e..d519af3 100644 --- a/02-basic/.golangci.yml +++ b/02-basic/.golangci.yml @@ -1,7 +1,10 @@ --- # golangci-lint configuration file made by @ccoVeille -# Source: https://github.com/ccoVeille/golangci-lint-config-examples/tree/main/02-basic +# Source: https://github.com/ccoVeille/golangci-lint-config-examples/ +# Author: @ccoVeille # License: MIT +# Variant: 02-basic +# Version: v1.0.0 # linters: # some linters are enabled by default diff --git a/03-safe/.golangci.yml b/03-safe/.golangci.yml index 4c75197..e895eb7 100644 --- a/03-safe/.golangci.yml +++ b/03-safe/.golangci.yml @@ -1,7 +1,10 @@ --- # golangci-lint configuration file made by @ccoVeille -# Source: https://github.com/ccoVeille/golangci-lint-config-examples/tree/main/03-safe +# Source: https://github.com/ccoVeille/golangci-lint-config-examples/ +# Author: @ccoVeille # License: MIT +# Variant: 03-safe +# Version: v1.0.0 # linters: # some linters are enabled by default diff --git a/03-safe/README.md b/03-safe/README.md index d520e5e..6dd6fde 100644 --- a/03-safe/README.md +++ b/03-safe/README.md @@ -14,8 +14,7 @@ It's [02-basic](../02-basic) plus : License: MIT -golangci-lint configuration file made by @ccoVeille -Source: https://github.com/ccoVeille/golangci-lint-config-examples/tree/main/03-safe +Source: [@ccoVeille](https://github.com/ccoVeille/golangci-lint-config-examples) ## Enabled linters diff --git a/README.md b/README.md index 04d633e..906a105 100644 --- a/README.md +++ b/README.md @@ -17,11 +17,6 @@ Each variant adds rules to the earlier one. License: MIT -golangci-lint configuration file made by @ccoVeille -Source: https://github.com/ccoVeille/golangci-lint-config-examples +Author: [@ccoVeille](https://github.com/ccoVeille) -## Changelog - -- 2024-06-28 - golangci-lint:1.59.1 - - initial version +Source: [ccoVeille/golangci-lint-config-examples](https://github.com/ccoVeille/golangci-lint-config-examples) From 788b33a15db7ccb55b5a8804f03e35435ba62acf Mon Sep 17 00:00:00 2001 From: ccoVeille <3875889+ccoVeille@users.noreply.github.com> Date: Sat, 29 Jun 2024 18:18:00 +0200 Subject: [PATCH 3/3] add: a global CHANGELOG --- .markdownlint.yaml | 4 ++++ 01-defaults/README.md | 5 ----- 02-basic/README.md | 6 ------ 03-safe/README.md | 6 ------ CHANGELOG.md | 14 ++++++++++++++ 5 files changed, 18 insertions(+), 17 deletions(-) create mode 100644 .markdownlint.yaml create mode 100644 CHANGELOG.md diff --git a/.markdownlint.yaml b/.markdownlint.yaml new file mode 100644 index 0000000..7878275 --- /dev/null +++ b/.markdownlint.yaml @@ -0,0 +1,4 @@ +--- + +# Default state for all rules +default: true diff --git a/01-defaults/README.md b/01-defaults/README.md index 31366aa..0035e97 100644 --- a/01-defaults/README.md +++ b/01-defaults/README.md @@ -27,9 +27,4 @@ Source: [@ccoVeille](https://github.com/ccoVeille/golangci-lint-config-examples) ### staticcheck It's a set of rules from staticcheck. See https://staticcheck.io/ -## Changelog - -- 2024-06-28 - golangci-lint:1.59.1 - - initial version diff --git a/02-basic/README.md b/02-basic/README.md index 3f6dc1b..0eda0de 100644 --- a/02-basic/README.md +++ b/02-basic/README.md @@ -96,9 +96,3 @@ report when a variable declaration can be simplified #### var-naming warns when initialism, variable or package naming conventions are not followed. - -## Changelog - -- 2024-06-28 - golangci-lint:1.59.1 - - initial version diff --git a/03-safe/README.md b/03-safe/README.md index 6dd6fde..bcb174b 100644 --- a/03-safe/README.md +++ b/03-safe/README.md @@ -117,9 +117,3 @@ report when a variable declaration can be simplified #### var-naming warns when initialism, variable or package naming conventions are not followed. - -## Changelog - -- 2024-06-28 - golangci-lint:1.59.1 - - initial version diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..9d293ca --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,14 @@ +# Changelog + + + + +All notable changes to this project will be documented in this file. + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), +and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +## [Unreleased] +### Added +- initial version +- LICENSE