Repository setup

[kinbiko]

Setting up repo for consistency with my other repos.

This document serves as both a list of all the rules and steps to set up a very good open source Go project, and also the issue contents of the GitHub issue generated by github.com/kinbiko/go-template's astroturf.sh script that automates a bunch of these very steps.

CI

• [x] Has golangci-lint v1.45.2 passing
• [x] Runs tests with the race detector
• [x] Runs integration tests, if applicable
• [x] Reports coverage to coveralls
• [x] Code scanning with CodeQL

Community Standards

• [x] Description w/ tags
• [x] README
• [x] Code of conduct
• [x] Contributing guideline
• [x] License
• [x] Issue template(s)
• [x] Pull request template
• [x] CODEOWNERS

GitHub settings

• [x] Wiki pages disabled
• [x] Sponsorship enabled
• [x] Projects disabled (my OSS work is managed in a central project board)
• [x] GitHub archive program enabled
• [x] Discussions disabled
• [x] Merge commits disabled
• [x] Squash merging enabled
• [x] Rebase merging disabled
• [x] Suggest updating branches enabled
• [x] Auto-merge disabled
• [x] Auto-delete head branches enabled
• [x] Limit "approve" or "request changes" to users with explicit permissions
• [x] Default branch is main, with the following branch protection rules enabled (everything else disabled):
  • [x] Require PRs before merging (no approvals required, don't dismiss PR approvals on new commits, don't require codeowner review)
  • [x] Linear history enabled (assumption: only enabling squash merges globally means linear history in default branch)
• [x] Allow kinbiko and select non-kinbiko actions only:
  • [x] Allow actions created by GitHub enabled
  • [x] Allow actions by Marketplace verified creators enabled
  • [x] shogo82148/actions-goveralls@v1 added as allowed action
• [x] Require approval before running actions for first-time contributors
• [x] GitHub actions approving PRs disabled
• [x] Dependabot alerts enabled for security vulns
• [x] Dependabot updates enabled for security vulns
• [x] Code scanning (CodeQL) enabled
• [x] Consistent labels:
  • bug
  • dependencies
  • documentation
  • enhancement
  • good first issue
  • help wanted
  • question

README

• [x] Has tags:
  • [x] Build status
  • [x] Coverage percentage
  • [x] Go report link
  • [x] Latest version
  • [x] Godoc with link to pkg.go.dev
  • [x] License tag
• [x] Explains the why and then the what.
• [x] Usage information incl any installation guidelines
• [x] Link to docs