From 445a14be5d12afdcb754df375dfc312f6ed7403d Mon Sep 17 00:00:00 2001 From: Scott Leggett Date: Mon, 18 Dec 2023 15:47:53 +0800 Subject: [PATCH 1/3] chore: add OpenSSF Best Practice badge to README --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index a6d5625..547b8e0 100644 --- a/README.md +++ b/README.md @@ -5,6 +5,7 @@ [![Coverage](https://coveralls.io/repos/github/smlx/go-cli-github/badge.svg?branch=main)](https://coveralls.io/github/smlx/go-cli-github?branch=main) [![Go Report Card](https://goreportcard.com/badge/github.com/smlx/go-cli-github)](https://goreportcard.com/report/github.com/smlx/go-cli-github) [![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/smlx/go-cli-github/badge)](https://securityscorecards.dev/viewer/?uri=github.com/smlx/go-cli-github) +[![OpenSSF Best Practices](https://www.bestpractices.dev/projects/8168/badge)](https://www.bestpractices.dev/projects/8168) This repository is a template for a Go CLI tool or service. It is quite opinionated about security and release engineering, but hopefully in a good way. From 1c5bebac7fc32c60a043f3f14ef4fe5b57f08acb Mon Sep 17 00:00:00 2001 From: Scott Leggett Date: Mon, 18 Dec 2023 15:54:02 +0800 Subject: [PATCH 2/3] chore: add section on contributions to README --- README.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/README.md b/README.md index 547b8e0..312a697 100644 --- a/README.md +++ b/README.md @@ -90,3 +90,10 @@ Configure the repository: 1. Go to repository Settings > Rules > Rulesets, and import the `protect-default-branch.json` ruleset. 1. That's it. + +## How to contribute + +Issues are welcome. + +PRs are also welcome, but keep in mind that this is a very opinionated template, so not all changes will be accepted. +PRs also need to ensure that test coverage remains high, and best practices are followed. From e9036c635de462daed0a811b2a20cc65622b1783 Mon Sep 17 00:00:00 2001 From: Scott Leggett Date: Mon, 18 Dec 2023 16:02:37 +0800 Subject: [PATCH 3/3] feat: generate better release notes --- .goreleaser.yml | 3 +++ 1 file changed, 3 insertions(+) diff --git a/.goreleaser.yml b/.goreleaser.yml index c53b41c..c4a1b18 100644 --- a/.goreleaser.yml +++ b/.goreleaser.yml @@ -18,6 +18,9 @@ builds: - amd64 - arm64 +changelog: + use: github-native + sboms: - artifacts: archive