Skip to content

Commit a46ff7d

Browse files
authored
Add go version information to contributing (#1648)
Signed-off-by: Todd Short <[email protected]>
1 parent 5cbfad0 commit a46ff7d

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

CONTRIBUTING.md

+8
Original file line numberDiff line numberDiff line change
@@ -149,6 +149,14 @@ focusing less on style conflicts, and more on the design and implementation deta
149149

150150
Please follow this style to make the operator-controller project easier to review, maintain and develop.
151151

152+
### Go version
153+
154+
Our goal is to minimize disruption by requiring the lowest possible Go language version. This means avoiding updaties to the go version specified in [go.mod](go.mod) (and other locations).
155+
156+
There is a GitHub PR CI job named `go-verdiff` that will inform a PR author if the Go language version has been updated. It is not a required test, but failures should prompt authors and reviewers to have a discussion with the community about the Go language version change.
157+
158+
There may be ways to avoid a Go language version change by using not-the-most-recent versions of dependencies. We do acknowledge that CVE fixes might require a specific dependency version that may have updated to a newer version of the Go language.
159+
152160
### Documentation
153161

154162
If the contribution changes the existing APIs or user interface it must include sufficient documentation to explain the

0 commit comments

Comments
 (0)