docs(#3343): add prerequisites section to README - #3348
docs(#3343): add prerequisites section to README#3348fullsend-ai-coder[bot] wants to merge 2 commits into
Conversation
Add a Prerequisites section before the Building heading that lists the required toolchain for building and developing ec-cli: Go 1.25.8+, Make, Podman/Docker, and Node.js 18+. Includes minimum versions derived from go.mod and package.json, and a cross-reference to the Podman troubleshooting section for Fedora/RHEL users. Closes #3343
|
🤖 Finished Review · ✅ Success · Started 10:26 AM UTC · Completed 10:33 AM UTC |
ReviewFindingsHigh
Low
Next steps:
Previous runLooks good to me Low
|
Codecov Report✅ All modified and coverable lines are covered by tests.
Flags with carried forward coverage won't be shown. Click here to find out more. 🚀 New features to boost your workflow:
|
|
🤖 Finished Review · ✅ Success · Started 11:13 AM UTC · Completed 11:24 AM UTC Commit: Runtime: claude · Model: opus → claude-opus-4-6 · Effort: high · Cost: $2.91 |
|
|
||
| ## Prerequisites | ||
|
|
||
| The following tools are required to build and work with `ec`: |
There was a problem hiding this comment.
[high] incorrect prerequisite version
The PR adds a Prerequisites section stating Go 1.25.8 or later as the minimum version, but go.mod declares go 1.26.3. Go 1.25.8 is a valid release but belongs to the previous major release line (1.25.x). Since go.mod requires 1.26.3, a contributor using Go 1.25.8 would be unable to build the project.
Suggested fix: Change the Go version in the Prerequisites section from 1.25.8 to 1.26.3 to match go.mod, or remove the hardcoded version and state Go (see version in go.mod) to avoid future staleness.
|
|
||
| ## Prerequisites | ||
|
|
||
| The following tools are required to build and work with `ec`: |
There was a problem hiding this comment.
[low] stale cross-reference risk
The Go version is hardcoded in the README Prerequisites section. Since go.mod is the source of truth and is updated independently, any future Go bump will leave the README stale again.
Suggested fix: Consider stating Go (see version in go.mod) instead of hardcoding a specific version number.
Add a Prerequisites section before the Building heading that lists the required toolchain for building and developing ec-cli: Go 1.25.8+, Make, Podman/Docker, and Node.js 18+. Includes minimum versions derived from go.mod and package.json, and a cross-reference to the Podman troubleshooting section for Fedora/RHEL users.
Closes #3343
Post-script verification
agent/3343-add-prerequisites-readme)15814bf9896060ce26a127adc995a1fbb60c3a77..HEAD)