docs(EC-1980): add product naming guidance to AGENTS.md

[cuipinghuo]

Summary

• Add product naming guidance to Key Conventions in AGENTS.md
• Explicitly states the project name is "Conforma CLI" (binary: ec)
• Instructs AI agents not to use the former name "ec-cli" in user-facing strings, even if issue descriptions reference the old name

Ref: EC-1980
Upstream: #3389

Test plan

• Verify AI code agents use "Conforma CLI" instead of "ec-cli" in generated strings on future PRs

🤖 Generated with Claude Code

[coderabbitai]

Warning

Review limit reached

@cuipinghuo, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 54 minutes

You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository.

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 8f1b3d32-d8d9-47f8-95d3-259abd0772e0

📥 Commits

Reviewing files that changed from the base of the PR and between 812b464 and 3fd6437.

📒 Files selected for processing (1)

• AGENTS.md

📝 Walkthrough

Walkthrough

The change adds an AGENTS.md convention that requires “Conforma CLI” and prohibits “ec-cli” in user-facing strings, errors, and documentation.

Changes

Naming convention

Layer / File(s)	Summary
Conforma CLI naming guidance AGENTS.md	Adds the required project name and prohibits the former name in user-facing content.

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

Suggested reviewers: joejstuart

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title clearly identifies the documentation change and the related ticket.
Description check	✅ Passed	The description explains the change, provides context, references EC-1980, and includes a test plan.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

✨ 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

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands.}

[qodo-for-conforma]

PR Summary by Qodo

Add product naming guidance to AGENTS.md (use “Conforma CLI”, not “ec-cli”)

📝 Documentation 🕐 Less than 5 minutes

AI Description

• Document the canonical product name as “Conforma CLI” (binary: ec).
• Instruct agents to avoid the deprecated “ec-cli” name in user-facing text.
• Reduce naming inconsistencies in generated strings, docs, and error messages.

High-Level Assessment

The approach is appropriate: establishing a single canonical product name in AGENTS.md is the lowest-overhead way to prevent recurring agent-generated naming regressions. Alternatives (linting user-facing strings or adding CI checks) would be heavier and are only justified if this continues to recur.

Files changed (1) +3 / -0

Documentation (1) +3 / -0

AGENTS.mdAdd canonical product naming convention (“Conforma CLI”) +3/-0

Add canonical product naming convention (“Conforma CLI”)

• Adds a Key Conventions entry defining the project name as “Conforma CLI” (binary 'ec'). Explicitly prohibits using the former “ec-cli” name in user-facing strings, error messages, or documentation even if referenced elsewhere.

AGENTS.md

[fullsend-ai-review]

🤖 Review · ⚠️ Cancelled · Started 2:54 AM UTC · Ended 2:59 AM UTC
Commit: 87c4a29 · View workflow run →

[coderabbitai]

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@AGENTS.md`:
- Around line 46-48: Revise the product-naming guidance in AGENTS.md to prohibit
“ec-cli” only in new user-facing product names and prose, while explicitly
allowing exact legacy identifiers required for compatibility, migration, or
historical context. Preserve required references such as the deprecated
quay.io/enterprise-contract/ec-cli registry image.

🪄 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 Plus

Run ID: 9c0e5cb3-4843-4a6f-8f15-a749bad28e2c

📥 Commits

Reviewing files that changed from the base of the PR and between 702c8c4 and 812b464.

📒 Files selected for processing (1)

• AGENTS.md

[qodo-for-conforma]

Code Review by Qodo

🐞 Bugs (0) 📘 Rule violations (0) 📜 Skill insights (0)

Context used

✅ Compliance rules (platform): 34 rules

✅ Skills: build-and-lint, pr-checklist, write-tests

1. Ambiguous ec-cli prohibition ✓ Resolved 🐞 Bug ⚙ Maintainability

Description

AGENTS.md bans using "ec-cli" in documentation, but the repo includes legitimate external/historical
identifiers that must remain accurate in docs (e.g., deprecated registry paths containing "ec-cli").
This ambiguity can mislead future PRs (including automated agents) into incorrectly renaming
identifiers or historical references that should not change without a migration plan.

Code

AGENTS.md[R46-48]

+- **Product name:** This project is "Conforma CLI" (binary name: `ec`). Do not use the former name
+  "ec-cli" in user-facing strings, error messages, or documentation, even if issue descriptions or
+  existing comments reference the old name.

Relevance

●●● Strong

PR #3021 kept legacy quay.io/enterprise-contract/ec-cli docs for backward compatibility; blanket
doc ban likely needs clarification.

PR-#3021
PR-#2583

ⓘ Recommendations generated based on similar findings in past PRs

Evidence

AGENTS.md introduces a blanket ban including documentation. The release process documentation
explicitly includes a deprecated image registry path that contains "ec-cli" for backward
compatibility; that string is an external identifier and should remain accurate even if the product
name changed.

AGENTS.md[46-48]
docs/modules/ROOT/pages/release-process.adoc[26-32]

Agent prompt

The issue below was found during a code review. Follow the provided context and guidance below and implement a solution

## Issue description
AGENTS.md currently states a blanket rule to not use the former name "ec-cli" in user-facing strings, error messages, or documentation. However, the repo has documentation that intentionally references external identifiers containing "ec-cli" (e.g., deprecated image registry names) where changing the string would make the docs incorrect.

## Issue Context
The intent seems to be: when referring to the product/project name, use "Conforma CLI". But some strings containing "ec-cli" are not product naming—they are immutable identifiers, deprecated registry paths, or compatibility references.

## Fix Focus Areas
- AGENTS.md[46-48]

ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools

---

_{To customize comments, go to the Qodo configuration screen, or learn more in the docs.}

[fullsend-ai-review]

🤖 Finished Review · ✅ Success · Started 2:59 AM UTC · Completed 3:07 AM UTC
Commit: 87c4a29 · View workflow run →

[fullsend-ai-review]

Review

Findings

Medium

• [protected-path] AGENTS.md — This PR modifies AGENTS.md, which is a protected governance file. The change is well-justified (linked to issue Add product naming guidance to conforma/cli AGENTS.md to prevent stale name usage in generated code #3389, adds product naming guidance to prevent stale name usage in AI-generated code), but human approval is always required for protected-path changes regardless of context.

---

Labels: PR modifies AGENTS.md documentation with product naming guidance

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.

Flag	Coverage Δ
acceptance	54.40% <ø> (ø)
generative	16.36% <ø> (ø)
integration	27.58% <ø> (ø)
unit	71.97% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[fullsend-ai-retro]

🤖 Finished Retro · ✅ Success · Started 12:28 PM UTC · Completed 12:41 PM UTC
Commit: 87c4a29 · View workflow run →

[fullsend-ai-retro]

Retro: PR #3457 — docs(EC-1980): add product naming guidance to AGENTS.md

Timeline

PR #3457 was a small (4 additions, 1 file) human-authored docs PR adding product naming guidance to AGENTS.md, co-authored with Claude. The workflow ran cleanly:

1. 02:53 UTC — PR opened, review dispatched (run 30873131266)
2. 02:55 UTC — CodeRabbit and Qodo flagged a real issue: blanket ec-cli prohibition conflicted with legitimate legacy identifiers like quay.io/enterprise-contract/ec-cli
3. 02:58 UTC — Author force-pushed fix (commit 3fd6437), addressing the ambiguity by adding an explicit exception for legacy identifiers
4. 02:59 UTC — First review cancelled (superseded), second review dispatched (run 30873377075)
5. 03:07 UTC — Review completed: 1 medium finding (protected-path — AGENTS.md is governance file, human approval required). Labels requires-manual-review and documentation applied.
6. 09:02 / 11:31 UTC — Two human reviewers (jsmid1, dheerajodha) approved
7. 12:27 UTC — Merged by cuipinghuo

Agents repo: fullsend-ai/agents (resolved from fullsend-ai/agents@v0, SHA 2534c9ee0aec)

What went well

• Multi-bot review ecosystem worked effectively. CodeRabbit and Qodo caught the ambiguous ec-cli prohibition within 2 minutes of PR open. The author fixed it before the fullsend review agent ran, so the fullsend review correctly found no issues with the corrected version.
• Protected-path detection was accurate. The review agent correctly identified AGENTS.md as governance documentation requiring human approval.
• Model failure recovery. Two sub-agents failed initially ("The sonnet model isn't available on this deployment") but the orchestrator retried without model specification and succeeded.
• Review was fast. ~8 minutes total for the successful run on a docs-only PR.

Evidence for existing open issues

All improvement opportunities identified in this retro are already tracked. New evidence from this PR:

• Retro agent should detect when a merged PR supersedes open agent-created PRs or issues fullsend-ai/agents#586 and Auto-flag linked issues for closure when agent PR is closed as superseded fullsend-ai/fullsend#2285: Issue #3389 remains OPEN with stale ready-to-code label despite PR docs(EC-1980): add product naming guidance to AGENTS.md #3457 being merged. Root cause: agent-authored PR #3390 had Closes #3389 but was closed without merge; human replacement PR docs(EC-1980): add product naming guidance to AGENTS.md #3457 used Upstream: reference format instead of a closing keyword. This is a concrete instance of the orphaned-issue pattern these issues aim to solve.

• Remove ready-to-code from linked issues when maintainer rejects implementing PR fullsend-ai/fullsend#3050 / Remove ready-to-code label from issues when implementing PR is rejected by maintainer fullsend-ai/fullsend#3818: Issue Add product naming guidance to conforma/cli AGENTS.md to prevent stale name usage in generated code #3389 still carries ready-to-code and ready-for-triage labels despite its implementing PR being merged. These labels are now stale and could mislead the code agent into creating another PR.

• Review sub-agents should handle model unavailability with fallback or explicit alerting fullsend-ai/agents#379 and Review sub-agents should fall back to an available model when the primary model is unavailable fullsend-ai/fullsend#1771: Two review sub-agents (style-conventions, intent-coherence) failed on first attempt due to sonnet model unavailability, requiring retry. The orchestrator handled it gracefully but wasted tokens and time.

• Skip irrelevant review dimensions for docs-only PRs to reduce token cost fullsend-ai/agents#373: Review cost $1.77 (28 turns, Opus model) for a 4-line docs-only change. Three sub-agents were dispatched (correctness, style-conventions, intent-coherence). While correctness verification was reasonable (grep-verified factual claims about project name and legacy identifiers), the full sub-agent roster may be unnecessarily heavyweight for XS documentation PRs.

No new proposals

All identified improvements are covered by existing open issues. No new proposals filed.