Skip to content

Commit a505978

Browse files
agabryspellared
andauthored
Refine README.md (#52)
Co-authored-by: Robert Pająk <[email protected]>
1 parent 932dfe3 commit a505978

File tree

1 file changed

+11
-12
lines changed

1 file changed

+11
-12
lines changed

README.md

Lines changed: 11 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ It includes:
1919
- linting with [golangci-lint](https://github.com/golangci/golangci-lint),
2020
- unit testing with [race detector](https://blog.golang.org/race-detector) and [code covarage HTML report](https://blog.golang.org/cover),
2121
- releasing using [GoReleaser](https://github.com/goreleaser/goreleaser),
22-
- depdendencies scanning and vulnerabilities alerting thanks to [Dependabot](https://dependabot.com/go/),
22+
- dependencies scanning and updating thanks to [Dependabot](https://dependabot.com),
2323
- [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.
2424

2525
`Star` this repository if you find it valuable and worth maintaining.
@@ -49,13 +49,13 @@ _CAUTION_: Make sure to understand the consequences before you bump the major ve
4949
Remember to update Go version in [.github/workflows](.github/workflows), [Makefile](Makefile) and [devcontainer.json](.devcontainer/devcontainer.json).
5050

5151
Notable files:
52-
- [devcontainer.json](.devcontainer/devcontainer.json) - Visual Studio Code Remote Container configuration
53-
- [.github/workflows](.github/workflows) - GitHub Actions workflows
54-
- [.github/dependabot.yml](.github/dependabot.yml) - Dependabot configuration
55-
- [.vscode](.vscode) - Visual Studio Code configuration files
56-
- [.golangci.yml](.golangci.yml) - golangci-lint configuration
57-
- [.goreleaser.yml](.goreleaser.yml) - GoReleaser configuration
58-
- [Makefile](Makefile) - Make targets used for development, [CI build](.github/workflows) and [.vscode/tasks.json](.vscode/tasks.json)
52+
- [devcontainer.json](.devcontainer/devcontainer.json) - Visual Studio Code Remote Container configuration,
53+
- [.github/workflows](.github/workflows) - GitHub Actions workflows,
54+
- [.github/dependabot.yml](.github/dependabot.yml) - Dependabot configuration,
55+
- [.vscode](.vscode) - Visual Studio Code configuration files,
56+
- [.golangci.yml](.golangci.yml) - golangci-lint configuration,
57+
- [.goreleaser.yml](.goreleaser.yml) - GoReleaser configuration,
58+
- [Makefile](Makefile) - Make targets used for development, [CI build](.github/workflows) and [.vscode/tasks.json](.vscode/tasks.json),
5959
- [go.mod](go.mod) - [Go module definition](https://github.com/golang/go/wiki/Modules#gomod),
6060
- [tools.go](tools.go) - [build tools](https://github.com/golang/go/wiki/Modules#how-can-i-track-tool-dependencies-for-a-module).
6161

@@ -87,7 +87,7 @@ Take a look at GoReleaser [docs](https://goreleaser.com/customization/) as well
8787

8888
### How can I create an application installation script
8989

90-
1. Install [GoDownloader](https://github.com/goreleaser/godownloader)
90+
1. Install [GoDownloader](https://github.com/goreleaser/godownloader).
9191
1. Execute:
9292

9393
```bash
@@ -113,7 +113,7 @@ release:
113113
prerelease: auto
114114
```
115115
116-
Alternativly you can completly remove the usage of GoReleaser if you prefer handcrafted release notes.
116+
Alternatively, you can completly remove the usage of GoReleaser if you prefer handcrafted release notes.
117117
118118
### Why the code coverage results are not accurate
119119
@@ -139,7 +139,7 @@ By default `go test` records code coverage for the package that is currently tes
139139
```
140140

141141
Codecov integration example:
142-
- [repository](https://github.com/pellared/codecov-integration-example).
142+
- [repository](https://github.com/pellared/codecov-integration-example),
143143
- [coverage report](https://codecov.io/gh/pellared/codecov-integration-example/src/master/cmd/seed/main.go),
144144
- [pull request comment](https://github.com/pellared/codecov-integration-example/pull/3#issuecomment-653814033).
145145

@@ -156,7 +156,6 @@ Auto-tagging can be done in many ways e.g. by using GitHub Actions like:
156156

157157
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.
158158

159-
160159
## Contributing
161160

162161
Simply create an issue or a pull request.

0 commit comments

Comments
 (0)