docs: add Go version management policy to CONTRIBUTING.md #13191
Conversation
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
Documents lotus's conservative Go version strategy: - Stay one minor version behind latest Go release - Gradual adoption with ~1 month transition period - Regular patch version updates for security/bug fixes Includes: - Philosophy and rationale behind version strategy - Timeline examples showing upgrade process - Step-by-step instructions for updating Go versions - File purposes and developer notes - Reference to PR #13190 as example implementation This formalizes the existing practices observed in recent Go version updates and provides clear guidance for future updates.
There was a problem hiding this comment.
Pull Request Overview
This PR adds a detailed Go version management policy to CONTRIBUTING.md, documenting the project’s conservative upgrade strategy and providing a step-by-step process for making Go version updates.
- Introduces a new “Go Version Management” section outlining philosophy, timeline, patch updates, and update process
- Details all files to update and a concrete step-by-step procedure for bumping Go versions
- Clarifies file purposes and developer notes regarding Go version tools
Comments suppressed due to low confidence (3)
CONTRIBUTING.md:121
- The update file list at the top of the process does not mention the
.go-versionfile, but it’s referenced later under File Purposes. Clarify whether.go-versionshould be updated or explicitly excluded from the version bump steps.
1. **`go.mod`** - The Go language version directive
CONTRIBUTING.md:102
- The indentation in this code block is uneven for lines 102–103, which may affect readability. Normalize the indentation to ensure consistent formatting.
Time t': Go 1.25.x is released. We continue using 1.23.x
CONTRIBUTING.md:122
- [nitpick] Consider renaming
GO_VERSION_MINtoGO_MIN_VERSIONor similar, which may read more naturally and align with common naming conventions for minimum-value variables.
2. **`GO_VERSION_MIN`** - Minimum version enforced by the Makefile
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
8 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary
🤖 Generated with Claude Code