Skip to content

Commit

Permalink
feat: add license
Browse files Browse the repository at this point in the history
and navigation via the README
  • Loading branch information
ccoVeille committed Jun 28, 2024
1 parent 61c30db commit 8e034f8
Show file tree
Hide file tree
Showing 9 changed files with 71 additions and 3 deletions.
4 changes: 4 additions & 0 deletions 00-empty/.golangci.yaml
Original file line number Diff line number Diff line change
@@ -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
Expand Down
7 changes: 7 additions & 0 deletions 00-empty/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
4 changes: 4 additions & 0 deletions 01-defaults/.golangci.yaml
Original file line number Diff line number Diff line change
@@ -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/
Expand Down
7 changes: 7 additions & 0 deletions 01-defaults/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 4 additions & 0 deletions 02-basics/.golangci.yaml → 02-basic/.golangci.yaml
Original file line number Diff line number Diff line change
@@ -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/
Expand Down
9 changes: 8 additions & 1 deletion 02-basics/README.md → 02-basic/README.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
4 changes: 4 additions & 0 deletions 03-safe/.golangci.yaml
Original file line number Diff line number Diff line change
@@ -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/
Expand Down
11 changes: 9 additions & 2 deletions 03-safe/README.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
24 changes: 24 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -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

Check failure on line 21 in README.md

View workflow job for this annotation

GitHub Actions / ci-lint

Bare URL used


## Changelog

- 2024-06-28 - golangci-lint:1.59.1

initial version

0 comments on commit 8e034f8

Please sign in to comment.