docs: align Go version in README and CONTRIBUTING with go.mod (1.26.3)#125
Open
abhicris wants to merge 1 commit into
Open
docs: align Go version in README and CONTRIBUTING with go.mod (1.26.3)#125abhicris wants to merge 1 commit into
abhicris wants to merge 1 commit into
Conversation
README badge and prerequisites listed Go 1.21.12 / 1.23.9 in different places, but go.mod requires Go 1.26.3. Bring the docs in sync so new contributors install a toolchain that can actually build the node.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Why
The docs disagree with each other and with
go.modabout the minimum Go toolchain. A new contributor who follows the README badge installs Go 1.21.12, hits the prerequisites line that says 1.23.9, and thengo buildfails becausego.moddeclaresgo 1.26.3. Fixing this saves the first-build friction.What changed
README.mdbadge:1.21.12to1.26.3README.md"Building From Source" prerequisite:>= 1.23.9to>= 1.26.3CONTRIBUTING.mdtop-of-file prerequisite:>= 1.23.9to>= 1.26.3CONTRIBUTING.md"Prerequisites" section:1.21.12 or higherto1.26.3 or higherSource of truth:
go.modline 10 (go 1.26.3).DockerfileARG is1.26.1which already builds against the same toolchain line.What didn't change
go.mod/go.sum, no workflows, no lockfiles.HISTORY.md/RELEASES.mdare left alone since they describe historical releases.