chore: updated AGENTS.md - #435
Conversation
📝 WalkthroughWalkthroughChangesContributor guidance
Estimated code review effort: 1 (Trivial) | ~5 minutes Suggested reviewers: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
|
Visit the preview URL for this PR (updated for commit 22c293c): https://react-koobiq-next--prs-435-l045yinp.web.app (expires Wed, 05 Aug 2026 10:35:04 GMT) 🔥 via Firebase Hosting GitHub Action 🌎 Sign: fc29847d4a9e5cb1adf458c76a9b681c76e2eeff |
|
@coderabbitai review |
✅ Action performedReview finished.
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (2)
AGENTS.md (2)
186-190: 🗄️ Data Integrity & Integration | 🔵 Trivial | ⚡ Quick winAdd public export steps to the API checklist.
tools/api-extractor/config.jsonregisters API reports. It does not replace exports from the componentindex.tsandpackages/components/src/components/index.ts. Add those export steps before updating the API Extractor registry and reports.Suggested checklist update
When adding a **new component** to the public API: -1. Add its name to the `components` array in `tools/api-extractor/config.json`. -2. Run `pnpm build && pnpm approve-api` to regenerate its `.api.md` report. -3. Commit the updated `config.json` and `.api.md` files alongside the component. +1. Export it through the component's local `index.ts` and `packages/components/src/components/index.ts`. +2. Add its name to the `components` array in `tools/api-extractor/config.json`. +3. Run `pnpm build && pnpm approve-api` to regenerate its `.api.md` report. +4. Commit the updated exports, `config.json`, and `.api.md` files alongside the component.🤖 Prompt for 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. In `@AGENTS.md` around lines 186 - 190, Update the new-component checklist in AGENTS.md to first require exporting the component from its component index.ts and from packages/components/src/components/index.ts, then retain the existing API Extractor registration and report-generation steps.
203-203: 📐 Maintainability & Code Quality | 🔵 Trivial | ⚡ Quick winDefine the documentation location for shared utilities.
Not every exported utility has a component-owned MDX file. Require component MDX for component-scoped utilities and package-level documentation for shared utilities.
Suggested wording
-Every exported utility needs its intended usage scenario documented in the component's MDX — +Every exported utility needs its intended usage scenario documented. Use the component's MDX for component-scoped utilities and package-level documentation for shared utilities.🤖 Prompt for 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. In `@AGENTS.md` at line 203, Update the documentation requirement in AGENTS.md to distinguish utility scope: require component-owned MDX for component-scoped exported utilities, and package-level documentation for shared utilities when no component MDX applies. Preserve the requirement to document each utility’s intended usage scenario.
🤖 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 150-151: Update the ARIA guidance in AGENTS.md to clarify that
aria-label and other standard ARIA attributes supplement, rather than replace,
visible-content props such as label; explicitly state that aria-label does not
render visible text.
---
Nitpick comments:
In `@AGENTS.md`:
- Around line 186-190: Update the new-component checklist in AGENTS.md to first
require exporting the component from its component index.ts and from
packages/components/src/components/index.ts, then retain the existing API
Extractor registration and report-generation steps.
- Line 203: Update the documentation requirement in AGENTS.md to distinguish
utility scope: require component-owned MDX for component-scoped exported
utilities, and package-level documentation for shared utilities when no
component MDX applies. Preserve the requirement to document each utility’s
intended usage scenario.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
| ``` | ||
|
|
||
| - All boolean props default to `false`. If `true` would be the natural default, invert the name (e.g. `hideArrow` instead of `showArrow={true}`). | ||
| - Prefer passing through real ARIA attributes (`role`, `aria-label`, `aria-labelledby`, `aria-hidden`) over inventing custom semantic props like `label`/`decorative` — it matches patterns consumers already know, and avoids clashing with props that mean something else elsewhere in the library (e.g. `label` usually means visible text). |
There was a problem hiding this comment.
Предлагаю оставить только первый пункт, перенести его в Prop System и сократить до: “Prefer standard ARIA attributes and existing prop names to keep component APIs consistent and familiar.” Второй и третий — удалить.
There was a problem hiding this comment.
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
AGENTS.md (1)
187-193: 🗄️ Data Integrity & Integration | 🟠 Major | ⚡ Quick winAdd public export registration to the API checklist.
The checklist updates API Extractor configuration and reports, but it does not tell contributors to export the component through its local
index.tsandpackages/components/src/components/index.ts, as required by Line 202. Add these steps before regenerating the API report.Proposed wording
When adding a **new component** to the public API: -1. Add its name to the `components` array in `tools/api-extractor/config.json`. -2. Run `pnpm build && pnpm approve-api` to regenerate its `.api.md` report. -3. Commit the updated `config.json` and `.api.md` files alongside the component. +1. Export it through its local `index.ts` and `packages/components/src/components/index.ts`. +2. Add its name to the `components` array in `tools/api-extractor/config.json`. +3. Run `pnpm build && pnpm approve-api` to regenerate its `.api.md` report. +4. Commit the updated exports, `config.json`, and `.api.md` files alongside the component.🤖 Prompt for 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. In `@AGENTS.md` around lines 187 - 193, Update the public API checklist in AGENTS.md to instruct contributors to export each new component from its local index.ts and from packages/components/src/components/index.ts before running pnpm build && pnpm approve-api and committing the generated API files.
🤖 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.
Outside diff comments:
In `@AGENTS.md`:
- Around line 187-193: Update the public API checklist in AGENTS.md to instruct
contributors to export each new component from its local index.ts and from
packages/components/src/components/index.ts before running pnpm build && pnpm
approve-api and committing the generated API files.
2 participants
Updated AGENTS.md according to latest review from angular developers.
It initiates common rules for stories creation, component architecture, etc.
Summary by CodeRabbit