Skip to content

docs(#3343): add prerequisites section to README - #3348

Open
fullsend-ai-coder[bot] wants to merge 2 commits into
mainfrom
agent/3343-add-prerequisites-readme
Open

docs(#3343): add prerequisites section to README#3348
fullsend-ai-coder[bot] wants to merge 2 commits into
mainfrom
agent/3343-add-prerequisites-readme

Conversation

@fullsend-ai-coder

Copy link
Copy Markdown
Contributor

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

  • Branch is not main/master (agent/3343-add-prerequisites-readme)
  • Secret scan passed (gitleaks — 15814bf9896060ce26a127adc995a1fbb60c3a77..HEAD)
  • Pre-commit hooks passed (authoritative run on runner)
  • Tests ran inside sandbox

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
@fullsend-ai-review

fullsend-ai-review Bot commented Jun 19, 2026

Copy link
Copy Markdown

🤖 Finished Review · ✅ Success · Started 10:26 AM UTC · Completed 10:33 AM UTC
Commit: 47d3320 · View workflow run →

@fullsend-ai-review

fullsend-ai-review Bot commented Jun 19, 2026

Copy link
Copy Markdown

Review

Findings

High

  • [incorrect prerequisite version] README.md:16 — 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.
    Remediation: 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 direct readers to go.mod to avoid future staleness.

Low

  • [stale cross-reference risk] README.md:16 — 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 version bump will leave the README stale again. The diff partially mitigates this by including a cross-reference to go.mod, but the hardcoded version number remains.
    Remediation: Consider removing the hardcoded version and stating "Go (see version in go.mod)" instead, or accept the maintenance burden of updating the README on each Go bump.

Next steps:

  • /fs-fix — agent addresses review findings automatically
  • /fs-fix <your instruction> — agent fixes with your specific guidance
  • Push commits directly — review re-runs automatically on push
  • /fs-fix-stop — disable automatic fix runs for this PR
Previous run

Looks good to me

Low

  • [pattern-inconsistency] README.md:18 — The existing README uses * (asterisk with 2-space indent) for bullet lists (lines 6–9), but the new Prerequisites section uses - (hyphen, no indent). This is a minor formatting inconsistency.
    Remediation: Consider using * to match the existing bullet style, or standardize on - throughout.

fullsend-ai-review[bot]

This comment was marked as outdated.

@fullsend-ai-review fullsend-ai-review Bot added the ready-for-merge All reviewers approved — ready to merge label Jun 19, 2026
@codecov

codecov Bot commented Jun 19, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

Flag Coverage Δ
acceptance 54.45% <ø> (-0.02%) ⬇️
generative 12.27% <ø> (ø)
integration 23.59% <ø> (ø)
unit 72.21% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.
see 1 file with indirect coverage changes

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

dheerajodha
dheerajodha previously approved these changes Aug 4, 2026
@fullsend-ai-review

fullsend-ai-review Bot commented Aug 26, 2026

Copy link
Copy Markdown

🤖 Finished Review · ✅ Success · Started 11:13 AM UTC · Completed 11:24 AM UTC

Commit: 87c4a29 · View workflow run →

Runtime: claude · Model: opus → claude-opus-4-6 · Effort: high · Cost: $2.91

@fullsend-ai-review fullsend-ai-review 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.

See the review comment for full details.

Comment thread README.md

## Prerequisites

The following tools are required to build and work with `ec`:

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

[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.

Comment thread README.md

## Prerequisites

The following tools are required to build and work with `ec`:

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

[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.

@fullsend-ai-review fullsend-ai-review Bot removed the ready-for-merge All reviewers approved — ready to merge label Aug 26, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add system requirements and prerequisites section to README

1 participant