Skip to content

docs: document Go versions for rules - #1766

Open
ColumbusLabs wants to merge 1 commit into
mgechev:masterfrom
ColumbusLabs:docs/readme-go-versions
Open

docs: document Go versions for rules#1766
ColumbusLabs wants to merge 1 commit into
mgechev:masterfrom
ColumbusLabs:docs/readme-go-versions

Conversation

@ColumbusLabs

@ColumbusLabs ColumbusLabs commented Aug 8, 2026

Copy link
Copy Markdown

Motivation

The available-rules table currently does not show which target Go versions each rule applies to. This makes version-gated rules difficult to identify without reading their implementations or individual descriptions.

Changes

  • add a Go version column covering all 104 registered rules
  • document minimum, maximum, and behavior-change versions from the rule implementations
  • add the missing multiline-if-init table row so the table matches the rule registry
  • explain Any and target-version semantics below the table

Closes #1311

@alexandear alexandear left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for the PR.

I have a few suggestions:

  1. Please mirror the newly added Go version information to each rule in RULES_DESCRIPTIONS.md.
  2. Use "1.0" instead of "Any". "Any" may be confused with the any alias for interface{}.
  3. Document the behavior changes only in RULES_DESCRIPTIONS.md; this information is excessive for the table in README.md.

@ColumbusLabs
ColumbusLabs force-pushed the docs/readme-go-versions branch from 5d6484b to 113eef1 Compare August 14, 2026 16:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add go version information for each rule in documentation

2 participants