From 711d8afb4c85638ec78eab886699459edd997a7e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Robert=20Paj=C4=85k?= Date: Wed, 12 Oct 2022 13:38:54 +0200 Subject: [PATCH 1/5] Fix typo --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index c50bf52..a37709f 100644 --- a/README.md +++ b/README.md @@ -135,7 +135,7 @@ how it is dogfooding its functionality. You can use it to add deb/rpm/snap packages, Homebrew Tap, Scoop App Manifest etc. If you are developing a library and you like handcrafted changelog and release notes, -you free to remove any usage of GoReleaser. +you are free to remove any usage of GoReleaser. ## Contributing From f8af0b38701330902828de8e97718ee03855ad70 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Robert=20Paj=C4=85k?= Date: Wed, 12 Oct 2022 13:41:25 +0200 Subject: [PATCH 2/5] Update README.md --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index a37709f..f4d61a3 100644 --- a/README.md +++ b/README.md @@ -139,4 +139,6 @@ you are free to remove any usage of GoReleaser. ## Contributing -Simply create an issue or a pull request. +Feel free to create an issue or propose a pull request. + +Follow the [Code of Conduct](CODE_OF_CONDUCT.md). From d63b7fb8dfef588529ea6c14a878a5d29ecbafe1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Robert=20Paj=C4=85k?= Date: Wed, 12 Oct 2022 13:47:27 +0200 Subject: [PATCH 3/5] Update README.md --- README.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index f4d61a3..c092337 100644 --- a/README.md +++ b/README.md @@ -9,6 +9,12 @@ [![Go Report Card](https://goreportcard.com/badge/github.com/golang-templates/seed)](https://goreportcard.com/report/github.com/golang-templates/seed) [![Codecov](https://codecov.io/gh/golang-templates/seed/branch/main/graph/badge.svg)](https://codecov.io/gh/golang-templates/seed) +⭐ `Star` this repository if you find it valuable and worth maintaining. + +👁 `Watch` this repository to get notified about new releases, issues, etc. + +## Description + This is a GitHub repository template for Go. It has been created for ease-of-use for anyone who wants to: - quickly get into Go without losing too much time on environment setup, @@ -31,10 +37,6 @@ It includes: - security code analysis using [CodeQL Action](https://docs.github.com/en/github/finding-security-vulnerabilities-and-errors-in-your-code/about-code-scanning), - [Visual Studio Code](https://code.visualstudio.com) configuration with [Go](https://code.visualstudio.com/docs/languages/go) support. -`Star` this repository if you find it valuable and worth maintaining. - -`Watch` this repository to get notified about new releases, issues, etc. - ## Usage 1. Sign up on [Codecov](https://codecov.io/) and configure [Codecov GitHub Application](https://github.com/apps/codecov) for all repositories. From e808d74fdfec2f1d722e2b7e4dcec940609aa679 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Robert=20Paj=C4=85k?= Date: Wed, 12 Oct 2022 13:54:27 +0200 Subject: [PATCH 4/5] Update README.md --- README.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index c092337..5669b4b 100644 --- a/README.md +++ b/README.md @@ -15,10 +15,11 @@ ## Description -This is a GitHub repository template for Go. It has been created for ease-of-use for anyone who wants to: +This is a GitHub repository template for a Go application. +You can use it: -- quickly get into Go without losing too much time on environment setup, -- create a new repoisitory with basic Continuous Integration. +- to create a new repoisitory with automation and environment setup, +- as reference when improving automation for an existing repository. It includes: From e3e6996b74306ab88743e97b853a695877becb77 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Robert=20Paj=C4=85k?= Date: Wed, 12 Oct 2022 13:56:53 +0200 Subject: [PATCH 5/5] Update README.md --- README.md | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 5669b4b..64df40b 100644 --- a/README.md +++ b/README.md @@ -40,7 +40,8 @@ It includes: ## Usage -1. Sign up on [Codecov](https://codecov.io/) and configure [Codecov GitHub Application](https://github.com/apps/codecov) for all repositories. +1. Sign up on [Codecov](https://codecov.io/) and configure + [Codecov GitHub Application](https://github.com/apps/codecov) for all repositories. 1. Click the `Use this template` button (alt. clone or download this repository). 1. Replace all occurrences of `golang-templates/seed` to `your_org/repo_name` in all files. 1. Replace all occurrences of `seed` to `repo_name` in [Dockerfile](Dockerfile). @@ -53,7 +54,10 @@ It includes: ## Setup Below you can find sample instructions on how to set up the development environment. -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. +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. 1. Install [Go](https://golang.org/doc/install). 1. Install [Visual Studio Code](https://code.visualstudio.com/). @@ -76,7 +80,9 @@ Of course you can use other tools like [GoLand](https://www.jetbrains.com/go/), The release workflow is triggered each time a tag with `v` prefix is pushed. -_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). +_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). ## Maintenance