Skip to content

docs: state the Go 1.26.10 minimum that go.mod requires - #58

Merged
Aswin-V merged 1 commit into
masterfrom
docs/readme-go-version
Nov 10, 2026
Merged

Aswin-V merged 1 commit into
masterfrom
docs/readme-go-version

Conversation

@Kartikey1306

@Kartikey1306 Kartikey1306 commented Nov 10, 2026 •

Copy link
Copy Markdown
Contributor

Summary

README.md and examples/hello-eipc/README.md said "Go 1.22+" and CONTRIBUTING.md's prerequisites table said "1.21+", but go.mod requires go 1.26.10. All three now state 1.26.10 and point at the go line in go.mod.

Type of Change

  • feat — New feature
  • fix — Bug fix
  • docs — Documentation only
  • style — Formatting, no code change
  • refactor — Code restructuring without behavior change
  • test — Add or fix tests
  • build — Build system or dependency changes
  • ci — CI/CD pipeline changes
  • perf — Performance improvement

Changes

  • README.md:49: Go 1.22+ -> Go 1.26.10 or newer (the go line in go.mod sets this minimum).
  • examples/hello-eipc/README.md:7: the same line. The example builds from the root module, so it has the same minimum.
  • CONTRIBUTING.md:9: the prerequisites table cell 1.21+ -> 1.26.10+ (the go line in go.mod).

CONTRIBUTING.md:122 (chore: bump go version to 1.22) is an example commit message, not a requirement, and is left alone.

To find every place that names a Go version, including table cells:

git grep -n -i -E 'go[ |:`v-]{1,6}1\.[0-9]+' -- ':!*.go' ':!go.sum' | grep -v '1\.26\.10'

On master 70748b2 this prints exactly the three lines above. On this branch it prints nothing.

Testing

  • Unit tests pass (ctest --test-dir build --output-on-failure)
  • Integration tests pass
  • Manual testing performed
  • New tests added for new functionality

Run on macOS 26 arm64 at 3353732. Go 1.22.12 and 1.26.10 were fetched with the Go toolchain mechanism (GOTOOLCHAIN=go1.x.y go version) and then run with GOTOOLCHAIN=local, so each one really is the version it reports.

Check Command Result
Go 1.22.12 (old stated minimum) on master 70748b2 GOTOOLCHAIN=local go build ./... FAIL as expected: go: go.mod requires go >= 1.26.10 (running go 1.22.12; GOTOOLCHAIN=local)
Go 1.26.10 (new stated minimum) on this branch GOTOOLCHAIN=local go build ./... PASS
Docs vs go.mod, master docs-check.sh <tree> (reads the go line, runs the grep above over every non-Go file, fails on any match that is not 1.26.10) FAIL as expected: README.md:49, CONTRIBUTING.md:9, examples/hello-eipc/README.md:7
Docs vs go.mod, this branch same PASS: every match states Go 1.26.10
Build / vet (as in CI) go build ./..., go vet ./... PASS
Gofmt (as in CI) gofmt -l cmd core transport PASS, 0 files
Test (as in CI) go test -race -count=1 ./... PASS: 18 packages ok, 7 with no test files
Book build book-build.yml NOT RUN locally (needs pandoc/LaTeX; runs on this PR)

Pre-Submission Checklist

  • Code compiles without warnings (-Wall -Wextra -Werror for C): no code touched
  • All existing tests pass
  • New tests added for new functionality: docs only
  • Documentation updated if API changed: this is the documentation change
  • Commit messages follow (): convention
  • Branch is rebased on latest master

Closing issue

Fixes #57

Screenshots / Logs

Go 1.22.12 against master, Go 1.26.10 against this branch, and the docs check before and after:

Go version before and after

Additional Notes

The README gives the floor rather than a single version on purpose, so it stays right when a newer Go is used. If the floor in go.mod moves again, this line moves with it.

Summary by Sourcery

Documentation:

  • Update the README, contributor guide, and example documentation to consistently state Go 1.26.10 as the minimum supported version and reference go.mod.

Summary by CodeRabbit

  • Documentation
    • Updated the Go prerequisite across the project and example documentation to Go 1.26.10 or newer, replacing the previously stated minimum versions. This clarifies the version needed to work with the project.

README.md and examples/hello-eipc/README.md said Go 1.22+, and the
prerequisites table in CONTRIBUTING.md said 1.21+, but go.mod requires
go 1.26.10. The floor was raised to 1.26.9 for the October security
releases (48d4a4a) and then to 1.26.10 to distrust the compromised CA
keys (2315c1f, #49). A Go 1.22 toolchain with GOTOOLCHAIN=local stops
with "go.mod requires go >= 1.26.10".
@qodo-code-review

Copy link
Copy Markdown

ⓘ Your Qodo trial ends soon. Ask your workspace admin to set up billing to keep reviews running after the trial. Manage billing

@kody-ai

kody-ai Bot commented Nov 10, 2026

Copy link
Copy Markdown

You've used all your free Kodus-paid PR reviews 🎁

Your trial is still active — this just means the PR reviews we cover during the trial are used up.

Connect your own AI key to keep Kody reviewing — unlimited reviews, on any plan (Free included).

Want more trial reviews to finish evaluating before adding a key? Talk to our founders. 😎

@sourcery-ai

sourcery-ai Bot commented Nov 10, 2026 •

Copy link
Copy Markdown

Reviewer's Guide

Documentation

Update the Go minimum in the project README and example README to match the requirement in go.mod.

  • README.md L49
  • examples/hello-eipc/README.md L7

Correct the Go version in the contributor prerequisites table to match the go.mod minimum.

  • CONTRIBUTING.md L9

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@coderabbitai

coderabbitai Bot commented Nov 10, 2026 •

Copy link
Copy Markdown

Explain Change →

No actionable comments were generated in the recent review.

Walkthrough

Three documentation files now state that Go 1.26.10 is the minimum version. The README files refer to go.mod as the source of the minimum.

Changes: Go version requirement documentation

Layer / File(s) Summary
Align documented Go requirements
README.md, CONTRIBUTING.md, examples/hello-eipc/README.md
The three documents now state a minimum Go version of 1.26.10. The README files note that go.mod sets the minimum. CONTRIBUTING.md retains the stated purpose of building and testing EIPC.

Estimated code review effort: 1 (Trivial) | ~3 minutes

Change: Other · Severity of issue fixed: Low

Merge Risk: Minimal · up to 33537

The documentation now states the intended Go minimum; no merge-blocking risk is identified.

Pre-merge checks: Passed 5

Check name Status Explanation
Description Check Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check Passed The title clearly summarizes the main change: updating the documentation to state the Go 1.26.10 minimum required by go.mod.
Linked Issues check Passed Issue #57 requires the three documents to state the Go 1.26.10 minimum enforced by go.mod. The diff updates README.md, examples/hello-eipc/README.md, and the CONTRIBUTING.md prerequisites table to sta…
Out of Scope Changes check Passed The diff changes only the three Go-version documentation entries requested by issue #57. No unrelated changes are present.
Docstring Coverage Passed No eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documentat…
Full details: Linked Issues check

Explanation

Issue #57 requires the three documents to state the Go 1.26.10 minimum enforced by go.mod. The diff updates README.md, examples/hello-eipc/README.md, and the CONTRIBUTING.md prerequisites table to state Go 1.26.10 or newer and reference the go line in go.mod.

Full details: Docstring Coverage

Explanation

No eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documentation-only edits and deletions within surviving functions are included; unchanged diff context and fully deleted functions are excluded. Analyzed 0 functions across 0 files. (3 skipped: 3 unsupported.)

Finishing Touches

Generate unit tests (beta)

  • Commit to this branch
  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

Share

Recent review info

Run configuration

  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: defaults
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: b56d5036-d16c-4e5f-9219-09ecadf457e1
Commits

Reviewing files that changed from the base of the PR and between 70748b2 and 3353732.

Files selected for processing: 3

  • CONTRIBUTING.md
  • README.md
  • examples/hello-eipc/README.md

Included review availability: This review used your included allowance. Your plan provides up to 1 included review per hour; 0 remain after this review.

@qodo-code-review

Copy link
Copy Markdown

Code Review by Qodo

🐞 Bugs (0) 📘 Rule violations (0) 📎 Requirement gaps (0)

Great, no issues found!

Qodo reviewed your code and found no material issues that require review

Qodo Logo

@qodo-code-review

Copy link
Copy Markdown

PR Summary by Qodo

Align documented Go minimum with go.mod

📝 Documentation 🕐 Less than 5 minutes

Grey Divider

AI Description

• Correct the documented Go minimum from 1.21+/1.22+ to 1.26.10 across three guides.
• Point readers to the go line in go.mod as the source of the requirement.
Diagram

graph TD
  G[("go.mod")] --> R["README.md"] & C["CONTRIBUTING.md"] & E["Example README"]
Loading
High-Level Assessment

Keep the explicit minimum in each prerequisite section and reference go.mod. A generated shared value would add machinery for three straightforward documentation statements.

Files changed (3) +3 / -3

Documentation (3) +3 / -3
CONTRIBUTING.mdCorrect the contributor Go prerequisite +1/-1

Correct the contributor Go prerequisite

• Changes the prerequisites table from Go 1.21+ to 1.26.10+ and identifies the 'go' line in 'go.mod' as its source.

CONTRIBUTING.md

README.mdCorrect the project Go requirement +1/-1

Correct the project Go requirement

• Replaces Go 1.22+ with Go 1.26.10 or newer and points to the minimum defined in 'go.mod'.

README.md

README.mdCorrect the example Go prerequisite +1/-1

Correct the example Go prerequisite

• Replaces Go 1.22+ with Go 1.26.10 or newer, matching the root module's 'go.mod' requirement.

examples/hello-eipc/README.md

@sourcery-ai

sourcery-ai Bot commented Nov 10, 2026

Copy link
Copy Markdown

Linked issues

Checked at commit 3353732

#57 README and CONTRIBUTING say Go 1.22+ / 1.21+, but go.mod requires Go 1.26.10 · 3 of 3 met

# Requirement Status Notes
1 README.md states the Go 1.26.10 minimum required by go.mod. ✅ Met README.md says Go 1.26.10 or newer and points to the go line in go.mod.
2 examples/hello-eipc/README.md states the Go 1.26.10 minimum required by go.mod. ✅ Met The example README says Go 1.26.10 or newer and points to the go line in go.mod.
3 CONTRIBUTING.md states the Go 1.26.10 minimum required by go.mod. ✅ Met The prerequisites table now lists Go 1.26.10+ and points to the go line in go.mod.

@sourcery-ai sourcery-ai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Hey - I've reviewed your changes and they look great!

Sourcery assessment

Approved.


Sourcery is free for open source - if you like our reviews please consider sharing them ✨

@Aswin-V
Aswin-V merged commit 3e1f05c into master Nov 10, 2026
16 checks passed
@Aswin-V
Aswin-V deleted the docs/readme-go-version branch November 10, 2026 18:59
@Aswin-V

Aswin-V commented Nov 10, 2026

Copy link
Copy Markdown
Contributor

Premise: pass — go.mod requires go 1.26.10; README.md:49 said Go 1.22+, CONTRIBUTING.md:9 said 1.21+, examples/hello-eipc/README.md:7 said Go 1.22+; all three now state 1.26.10 (docs-only, +3/-3).
Contract: n/a — docs-only.
CI: green @33537321 (16 checks; Build & Test all 3 OSes success; policy success).
Integration: Integration-unverified: infra (nightly Unified Build quota failure, 6th night).
Reviewer: loop run 2026-11-10 (stewardship batch 2, premise verified vs live master)
Second look: n/a (not multi-look class)

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.

README and CONTRIBUTING say Go 1.22+ / 1.21+, but go.mod requires Go 1.26.10

2 participants