From 61e5d526eee5b5345c84ec9c3f5e4f2af5ba0f88 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Adam=20Gabry=C5=9B?= Date: Mon, 6 Jul 2020 13:01:10 +0200 Subject: [PATCH 1/2] make formatting of ordered and unordered lists consistent List were formatted inconsistently - items are ended with commas, dots or nothing. Items in ordered lists in most cases were ended with dots and in unordered with commas (the last one with a dot). This commit adds missing dot/comma character to all list items, so all lists are formatted according to the previously described rule (ordered - dot, unordered - comma) --- README.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 3c1749a..d2dd737 100644 --- a/README.md +++ b/README.md @@ -49,13 +49,13 @@ _CAUTION_: Make sure to understand the consequences before you bump the major ve Remember to update Go version in [.github/workflows](.github/workflows), [Makefile](Makefile) and [devcontainer.json](.devcontainer/devcontainer.json). Notable files: -- [devcontainer.json](.devcontainer/devcontainer.json) - Visual Studio Code Remote Container configuration -- [.github/workflows](.github/workflows) - GitHub Actions workflows -- [.github/dependabot.yml](.github/dependabot.yml) - Dependabot configuration -- [.vscode](.vscode) - Visual Studio Code configuration files -- [.golangci.yml](.golangci.yml) - golangci-lint configuration -- [.goreleaser.yml](.goreleaser.yml) - GoReleaser configuration -- [Makefile](Makefile) - Make targets used for development, [CI build](.github/workflows) and [.vscode/tasks.json](.vscode/tasks.json) +- [devcontainer.json](.devcontainer/devcontainer.json) - Visual Studio Code Remote Container configuration, +- [.github/workflows](.github/workflows) - GitHub Actions workflows, +- [.github/dependabot.yml](.github/dependabot.yml) - Dependabot configuration, +- [.vscode](.vscode) - Visual Studio Code configuration files, +- [.golangci.yml](.golangci.yml) - golangci-lint configuration, +- [.goreleaser.yml](.goreleaser.yml) - GoReleaser configuration, +- [Makefile](Makefile) - Make targets used for development, [CI build](.github/workflows) and [.vscode/tasks.json](.vscode/tasks.json), - [go.mod](go.mod) - [Go module definition](https://github.com/golang/go/wiki/Modules#gomod), - [tools.go](tools.go) - [build tools](https://github.com/golang/go/wiki/Modules#how-can-i-track-tool-dependencies-for-a-module). @@ -87,7 +87,7 @@ Take a look at GoReleaser [docs](https://goreleaser.com/customization/) as well ### How can I create an application installation script -1. Install [GoDownloader](https://github.com/goreleaser/godownloader) +1. Install [GoDownloader](https://github.com/goreleaser/godownloader). 1. Execute: ```bash @@ -139,7 +139,7 @@ By default `go test` records code coverage for the package that is currently tes ``` Codecov integration example: -- [repository](https://github.com/pellared/codecov-integration-example). +- [repository](https://github.com/pellared/codecov-integration-example), - [coverage report](https://codecov.io/gh/pellared/codecov-integration-example/src/master/cmd/seed/main.go), - [pull request comment](https://github.com/pellared/codecov-integration-example/pull/3#issuecomment-653814033). From e346f71b1c2338a629c449feac5a0a8cc0a52b4e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Robert=20Paj=C4=85k?= Date: Mon, 6 Jul 2020 16:56:01 +0200 Subject: [PATCH 2/2] Update README.md --- README.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index d2dd737..30f5e46 100644 --- a/README.md +++ b/README.md @@ -19,7 +19,7 @@ It includes: - linting with [golangci-lint](https://github.com/golangci/golangci-lint), - unit testing with [race detector](https://blog.golang.org/race-detector) and [code covarage HTML report](https://blog.golang.org/cover), - releasing using [GoReleaser](https://github.com/goreleaser/goreleaser), -- depdendencies scanning and vulnerabilities alerting thanks to [Dependabot](https://dependabot.com/go/), +- dependencies scanning and updating thanks to [Dependabot](https://dependabot.com), - [Visual Studio Code](https://code.visualstudio.com) configuration with [Go](https://code.visualstudio.com/docs/languages/go) and [Remote Container](https://code.visualstudio.com/docs/remote/containers) support. `Star` this repository if you find it valuable and worth maintaining. @@ -113,7 +113,7 @@ release: prerelease: auto ``` -Alternativly you can completly remove the usage of GoReleaser if you prefer handcrafted release notes. +Alternatively, you can completly remove the usage of GoReleaser if you prefer handcrafted release notes. ### Why the code coverage results are not accurate @@ -156,7 +156,6 @@ Auto-tagging can be done in many ways e.g. by using GitHub Actions like: However, creating a release tag manually is often the optimal approach. Take notice that this template executes a release workflow each time a git tag with `v` prefix is pushed. - ## Contributing Simply create an issue or a pull request.