Skip to content

fix(docs): fix formatting inconsistency, outdated Go version, and grammar#663

Open
archy-rock3t-cloud wants to merge 1 commit intoopenfga:mainfrom
sophotechlabs:fix/docs-and-formatting
Open

fix(docs): fix formatting inconsistency, outdated Go version, and grammar#663
archy-rock3t-cloud wants to merge 1 commit intoopenfga:mainfrom
sophotechlabs:fix/docs-and-formatting

Conversation

@archy-rock3t-cloud
Copy link
Copy Markdown

@archy-rock3t-cloud archy-rock3t-cloud commented Mar 30, 2026

Fix formatting inconsistency, outdated Go version, and grammar

Summary by CodeRabbit

Release Notes

  • Documentation

    • Updated the minimum required Go version to Go 1.25 or later for building from source.
    • Corrected grammatical phrasing in package documentation.
  • Style

    • Improved formatting of test result status messages for better readability.

Signed-off-by: Artem Muterko <artem@sopho.tech>
@archy-rock3t-cloud archy-rock3t-cloud requested review from a team as code owners March 30, 2026 14:31
Copilot AI review requested due to automatic review settings March 30, 2026 14:31
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Mar 30, 2026

Walkthrough

Three independent minor updates: Go version requirement bumped from 1.20 to 1.25 in README.md, grammar correction in a package documentation comment, and spacing adjustment in a test output string.

Changes

Cohort / File(s) Summary
Documentation & Build Requirements
README.md
Updated required Go version from 1.20 to 1.25 in the "Building from Source" prerequisites section.
Code Comments
internal/cmdutils/cmdutils.go
Fixed grammatical wording in package documentation comment: changed "that interaction with the input" to "that interact with the input."
Test Output Formatting
internal/storetest/testresult.go
Added space between function name and parentheses in test result output string: ListUsersListUsers .

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and accurately summarizes all three main changes: formatting inconsistency fix, outdated Go version update, and grammar correction.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown
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 aligns documentation and user-facing output text with current project requirements by fixing a minor formatting inconsistency, updating the documented Go version to match go.mod, and correcting grammar in a package comment.

Changes:

  • Normalize ListUsers summary output formatting to match other summary entries.
  • Fix grammar in the cmdutils package comment.
  • Update README “Building from Source” Go version requirement to Go 1.25+.

Reviewed changes

Copilot reviewed 2 out of 3 changed files in this pull request and generated no comments.

File Description
internal/storetest/testresult.go Adjusts ListUsers summary label formatting for consistency with Checks/ListObjects.
internal/cmdutils/cmdutils.go Fixes grammar in package-level documentation comment.
README.md Updates documented Go version requirement to Go 1.25 or later.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@README.md`:
- Line 111: The dev container base image still uses cgr.dev/chainguard/go:1.20;
update the FROM line in .dev.Dockerfile to the Go 1.25 image (e.g.,
cgr.dev/chainguard/go:1.25 or cgr.dev/chainguard/go:1.25.0) so it matches
README.md, go.mod (go 1.25.0) and CI which reads go-version-file; ensure any
pinned tags or references in that file are updated accordingly.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: dc2dd3a3-09ce-4e46-bf24-ca034b37d027

📥 Commits

Reviewing files that changed from the base of the PR and between 43059ce and dffd55e.

📒 Files selected for processing (3)
  • README.md
  • internal/cmdutils/cmdutils.go
  • internal/storetest/testresult.go

## Building from Source

Make sure you have Go 1.20 or later installed. See the [Go downloads](https://go.dev/dl/) page.
Make sure you have Go 1.25 or later installed. See the [Go downloads](https://go.dev/dl/) page.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟠 Major

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash
# Verify Go version consistency across docs, module, CI, and Dockerfiles.

set -euo pipefail

echo "README requirement:"
rg -n "Go [0-9]+\.[0-9]+|Go [0-9]+\.[0-9]+ or later" README.md -C 1

echo
echo "go.mod toolchain:"
rg -n "^go [0-9]+\.[0-9]+(\.[0-9]+)?$" go.mod -C 1

echo
echo "CI go-version source:"
rg -n "go-version-file|go-version" .github/workflows/main.yaml -C 2

echo
echo "Dockerfiles with Go base images:"
fd -a -i "Dockerfile" | xargs -r rg -n "FROM .*go:[0-9]+\.[0-9]+"

Repository: openfga/cli

Length of output: 1579


🏁 Script executed:

# Check if .dev.Dockerfile exists and examine its contents
fd -a -i "dockerfile" -o "dockerfile.*" 

# Also check the first line of any Dockerfile or .dev.Dockerfile
fd -type f -name "*[Dd]ocker*" | head -20

# If .dev.Dockerfile exists, show its contents
if [ -f ".dev.Dockerfile" ]; then
  echo "=== .dev.Dockerfile contents ===" && cat -n .dev.Dockerfile | head -20
fi

# Check all Dockerfile variants
for f in .dev.Dockerfile Dockerfile docker-compose.yml; do
  if [ -f "$f" ]; then
    echo "=== $f ===" && cat -n "$f" | head -10
  fi
done

Repository: openfga/cli

Length of output: 1270


Update .dev.Dockerfile to use Go 1.25 for consistency with documented and toolchain versions.

README.md requires Go 1.25+, go.mod specifies go 1.25.0, and CI workflows use go-version-file: './go.mod'. However, .dev.Dockerfile Line 1 still uses cgr.dev/chainguard/go:1.20. Update the dev container to Go 1.25 to prevent local dev/build drift.

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@README.md` at line 111, The dev container base image still uses
cgr.dev/chainguard/go:1.20; update the FROM line in .dev.Dockerfile to the Go
1.25 image (e.g., cgr.dev/chainguard/go:1.25 or cgr.dev/chainguard/go:1.25.0) so
it matches README.md, go.mod (go 1.25.0) and CI which reads go-version-file;
ensure any pinned tags or references in that file are updated accordingly.

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.

2 participants