Skip to content

docs: align CONTRIBUTING with canonical template#84

Merged
joshiste merged 1 commit into
mainfrom
docs/align-build-instructions
Jun 9, 2026
Merged

docs: align CONTRIBUTING with canonical template#84
joshiste merged 1 commit into
mainfrom
docs/align-build-instructions

Conversation

@joshiste

@joshiste joshiste commented Jun 9, 2026

Copy link
Copy Markdown
Member

Aligns this repo's CONTRIBUTING.md with the canonical structure used across the Steadybit Go extensions:

  • Adds an explicit Prerequisites section listing the build tools (Go, GNU Make, GoReleaser, Docker, Helm + helm-unittest) with required versions.
  • Documents the Makefile targets that actually exist (tidy, audit, build, run, container) and points readers at make help.
  • Keeps the release/Helm-chart/CLA sections in line with the other extension repos.

Local-build documentation is centralised here so README files can focus on deployment, install and configuration.

@sonarqubecloud

sonarqubecloud Bot commented Jun 9, 2026

Copy link
Copy Markdown

@joshiste joshiste merged commit 70e6e6b into main Jun 9, 2026
12 checks passed
@github-actions github-actions Bot locked and limited conversation to collaborators Jun 9, 2026
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant