Skip to content

docs: add Go version management policy to CONTRIBUTING.md#13191

Merged
BigLep merged 3 commits intomasterfrom
biglep/document-go-version-handling
Jul 1, 2025
Merged

docs: add Go version management policy to CONTRIBUTING.md#13191
BigLep merged 3 commits intomasterfrom
biglep/document-go-version-handling

Conversation

@BigLep
Copy link
Member

@BigLep BigLep commented Jun 30, 2025

Summary

  • Adds comprehensive Go version management policy to CONTRIBUTING.md
  • Documents lotus's conservative Go version strategy and upgrade process
  • Provides step-by-step instructions for future Go version updates

🤖 Generated with Claude Code

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.
Copilot AI review requested due to automatic review settings June 30, 2025 19:00
@github-project-automation github-project-automation bot moved this to 📌 Triage in FilOz Jun 30, 2025
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

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-version file, but it’s referenced later under File Purposes. Clarify whether .go-version should 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_MIN to GO_MIN_VERSION or 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

@BigLep BigLep self-assigned this Jun 30, 2025
@BigLep BigLep requested a review from rjan90 June 30, 2025 19:01
@BigLep BigLep moved this from 📌 Triage to 🔎 Awaiting Review in FilOz Jun 30, 2025
BigLep and others added 2 commits June 30, 2025 12:02
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Copy link
Member

@rvagg rvagg left a comment

Choose a reason for hiding this comment

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

nice

@github-project-automation github-project-automation bot moved this from 🔎 Awaiting Review to ✔️ Approved by reviewer in FilOz Jul 1, 2025
@BigLep BigLep merged commit cfb4c8e into master Jul 1, 2025
11 checks passed
@BigLep BigLep deleted the biglep/document-go-version-handling branch July 1, 2025 06:21
@github-project-automation github-project-automation bot moved this from ✔️ Approved by reviewer to 🎉 Done in FilOz Jul 1, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: 🎉 Done

Development

Successfully merging this pull request may close these issues.

3 participants