Skip to content

Commit f7154cf

Browse files
authored
Update README.md (golang-templates#214)
1 parent 5e0cba4 commit f7154cf

File tree

1 file changed

+23
-12
lines changed

1 file changed

+23
-12
lines changed

README.md

Lines changed: 23 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,17 @@
99
[![Go Report Card](https://goreportcard.com/badge/github.com/golang-templates/seed)](https://goreportcard.com/report/github.com/golang-templates/seed)
1010
[![Codecov](https://codecov.io/gh/golang-templates/seed/branch/main/graph/badge.svg)](https://codecov.io/gh/golang-templates/seed)
1111

12-
This is a GitHub repository template for Go. It has been created for ease-of-use for anyone who wants to:
12+
`Star` this repository if you find it valuable and worth maintaining.
1313

14-
- quickly get into Go without losing too much time on environment setup,
15-
- create a new repoisitory with basic Continuous Integration.
14+
👁 `Watch` this repository to get notified about new releases, issues, etc.
15+
16+
## Description
17+
18+
This is a GitHub repository template for a Go application.
19+
You can use it:
20+
21+
- to create a new repoisitory with automation and environment setup,
22+
- as reference when improving automation for an existing repository.
1623

1724
It includes:
1825

@@ -31,13 +38,10 @@ It includes:
3138
- security code analysis using [CodeQL Action](https://docs.github.com/en/github/finding-security-vulnerabilities-and-errors-in-your-code/about-code-scanning),
3239
- [Visual Studio Code](https://code.visualstudio.com) configuration with [Go](https://code.visualstudio.com/docs/languages/go) support.
3340

34-
`Star` this repository if you find it valuable and worth maintaining.
35-
36-
`Watch` this repository to get notified about new releases, issues, etc.
37-
3841
## Usage
3942

40-
1. Sign up on [Codecov](https://codecov.io/) and configure [Codecov GitHub Application](https://github.com/apps/codecov) for all repositories.
43+
1. Sign up on [Codecov](https://codecov.io/) and configure
44+
[Codecov GitHub Application](https://github.com/apps/codecov) for all repositories.
4145
1. Click the `Use this template` button (alt. clone or download this repository).
4246
1. Replace all occurrences of `golang-templates/seed` to `your_org/repo_name` in all files.
4347
1. Replace all occurrences of `seed` to `repo_name` in [Dockerfile](Dockerfile).
@@ -50,7 +54,10 @@ It includes:
5054
## Setup
5155

5256
Below you can find sample instructions on how to set up the development environment.
53-
Of course you can use other tools like [GoLand](https://www.jetbrains.com/go/), [Vim](https://github.com/fatih/vim-go), [Emacs](https://github.com/dominikh/go-mode.el). However take notice that the Visual Studio Go extension is [officially supported](https://blog.golang.org/vscode-go) by the Go team.
57+
Of course, you can use other tools like [GoLand](https://www.jetbrains.com/go/),
58+
[Vim](https://github.com/fatih/vim-go), [Emacs](https://github.com/dominikh/go-mode.el).
59+
However, take notice that the Visual Studio Go extension is
60+
[officially supported](https://blog.golang.org/vscode-go) by the Go team.
5461

5562
1. Install [Go](https://golang.org/doc/install).
5663
1. Install [Visual Studio Code](https://code.visualstudio.com/).
@@ -73,7 +80,9 @@ Of course you can use other tools like [GoLand](https://www.jetbrains.com/go/),
7380

7481
The release workflow is triggered each time a tag with `v` prefix is pushed.
7582

76-
_CAUTION_: Make sure to understand the consequences before you bump the major version. More info: [Go Wiki](https://github.com/golang/go/wiki/Modules#releasing-modules-v2-or-higher), [Go Blog](https://blog.golang.org/v2-go-modules).
83+
_CAUTION_: Make sure to understand the consequences before you bump the major version.
84+
More info: [Go Wiki](https://github.com/golang/go/wiki/Modules#releasing-modules-v2-or-higher),
85+
[Go Blog](https://blog.golang.org/v2-go-modules).
7786

7887
## Maintenance
7988

@@ -135,8 +144,10 @@ how it is dogfooding its functionality.
135144
You can use it to add deb/rpm/snap packages, Homebrew Tap, Scoop App Manifest etc.
136145

137146
If you are developing a library and you like handcrafted changelog and release notes,
138-
you free to remove any usage of GoReleaser.
147+
you are free to remove any usage of GoReleaser.
139148

140149
## Contributing
141150

142-
Simply create an issue or a pull request.
151+
Feel free to create an issue or propose a pull request.
152+
153+
Follow the [Code of Conduct](CODE_OF_CONDUCT.md).

0 commit comments

Comments
 (0)