Skip to content

Clarify rules in AGENTS.md#558

Open
celdrake wants to merge 2 commits intoflightctl:mainfrom
celdrake:clarify-agents
Open

Clarify rules in AGENTS.md#558
celdrake wants to merge 2 commits intoflightctl:mainfrom
celdrake:clarify-agents

Conversation

@celdrake
Copy link
Collaborator

@celdrake celdrake commented Mar 4, 2026

Summary by CodeRabbit

  • Improvements

    • Updated the "Provided by" provider attribution text in catalog items for clearer punctuation and consistency.
  • Accessibility

    • Improved selection aria labels for catalog items to more reliably reflect item names for assistive technologies.
  • Documentation

    • Refined maintainer guidance on handling generated files and localization workflows to prevent manual edits and clarify translation procedures.

@coderabbitai
Copy link

coderabbitai bot commented Mar 4, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 3193d553-e0d9-48d2-91cb-5b4eb8b60b90

📥 Commits

Reviewing files that changed from the base of the PR and between 682f3a5 and 0be9b56.

📒 Files selected for processing (3)
  • AGENTS.md
  • libs/i18n/locales/en/translation.json
  • libs/ui-components/src/components/Catalog/CatalogItemCard.tsx
🚧 Files skipped from review as they are similar to previous changes (3)
  • AGENTS.md
  • libs/ui-components/src/components/Catalog/CatalogItemCard.tsx
  • libs/i18n/locales/en/translation.json

Walkthrough

Updates AI agent guidance in documentation to forbid agent edits to generated files and translations, adds a new colon-delimited translation key, and refactors a catalog item component to use a local displayName constant and the new translation key.

Changes

Cohort / File(s) Summary
Documentation
AGENTS.md
Tightened guidance: agents must not modify or suggest edits to generated files or translation.json; clarified handling of resource.metadata.name (cast or default to satisfy linter).
Translations
libs/i18n/locales/en/translation.json
Added new key "Provided by: {{provider}}" (colon variant) while retaining existing "Provided by {{provider}}".
UI Component
libs/ui-components/src/components/Catalog/CatalogItemCard.tsx
Introduced local displayName constant; updated selectable actions aria-label to use displayName; switched provider text to the new "Provided by: {{provider}}" key.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 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 'Clarify rules in AGENTS.md' accurately reflects the primary change—updates to guidance and documentation in AGENTS.md. However, the changeset also includes modifications to translation.json and CatalogItemCard.tsx, which are not captured in the title. The title refers to a real and significant part of the change, but omits other substantive changes.
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
  • Post copyable unit tests in a comment

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

@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 `@AGENTS.md`:
- Around line 19-23: Edit AGENTS.md to fix the minor typos: remove the
duplicated period after the npm run i18n sentence in the Translations paragraph
(the ". .") and update the casing of "Typescript" to "TypeScript" in the
Conventions and assumptions section referencing resource.metadata.name and the
Typescript type handling note; keep the rest of the wording unchanged.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 70f34030-20a9-4702-a04f-711ba37812bb

📥 Commits

Reviewing files that changed from the base of the PR and between 06b11e2 and 682f3a5.

📒 Files selected for processing (3)
  • AGENTS.md
  • libs/i18n/locales/en/translation.json
  • libs/ui-components/src/components/Catalog/CatalogItemCard.tsx

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.

1 participant