feat: added design comments skill - #113
Conversation
📝 WalkthroughWalkthroughA new ChangesPF Design Comments Skill Documentation
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~5 minutes Possibly related PRs
Suggested reviewers
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Warning Review ran into problems🔥 ProblemsLinked repositories: Your configuration references 1 linked repositories, but your current plan allows 0. Analyzed ``, skipped 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 |
![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
🤖 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 `@plugins/react/skills/pf-design-comments/SKILL.md`:
- Around line 1-4: The pf-design-comments skill is missing the required
disable-model-invocation: true flag in its frontmatter. Add this flag to the
frontmatter section in the SKILL.md file alongside the existing name and
description fields to properly indicate that this skill has file-system side
effects and should only be invoked by users, not by the AI model
programmatically.
🪄 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: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Run ID: 01d243ea-8cdd-4558-a64e-405d6aa6d72e
📒 Files selected for processing (3)
PLUGINS.mdplugins/react/README.mdplugins/react/skills/pf-design-comments/SKILL.md
| --- | ||
| name: pf-design-comments | ||
| description: Integrate @patternfly/design-comments into React apps for on-page design feedback, pinned comment threads, GitHub Issues sync, and Jira linking. Use when adding design comments, review overlays, or removing the commenting system from a PatternFly React project. | ||
| --- |
There was a problem hiding this comment.
Add disable-model-invocation: true to frontmatter — this skill has side effects.
The skill executes npx design-comments init, which modifies multiple project files (src/app/index.tsx, src/app/routes.tsx, src/app/AppLayout/AppLayout.tsx, webpack.dev.js), creates new files (src/app/Comments/Comments.tsx, env templates), and adds webpack middleware. These are file-system mutations and therefore side effects that require the disable-model-invocation: true flag per PatternFly ai-helpers conventions (CONTRIBUTING-SKILLS.md and retrieved learnings on PR 77). This ensures only the user can invoke the skill, not the AI model programmatically.
🔧 Proposed frontmatter fix
---
name: pf-design-comments
description: Integrate `@patternfly/design-comments` into React apps for on-page design feedback, pinned comment threads, GitHub Issues sync, and Jira linking. Use when adding design comments, review overlays, or removing the commenting system from a PatternFly React project.
+disable-model-invocation: true
---📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| --- | |
| name: pf-design-comments | |
| description: Integrate @patternfly/design-comments into React apps for on-page design feedback, pinned comment threads, GitHub Issues sync, and Jira linking. Use when adding design comments, review overlays, or removing the commenting system from a PatternFly React project. | |
| --- | |
| --- | |
| name: pf-design-comments | |
| description: Integrate `@patternfly/design-comments` into React apps for on-page design feedback, pinned comment threads, GitHub Issues sync, and Jira linking. Use when adding design comments, review overlays, or removing the commenting system from a PatternFly React project. | |
| disable-model-invocation: true | |
| --- |
🤖 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 `@plugins/react/skills/pf-design-comments/SKILL.md` around lines 1 - 4, The
pf-design-comments skill is missing the required disable-model-invocation: true
flag in its frontmatter. Add this flag to the frontmatter section in the
SKILL.md file alongside the existing name and description fields to properly
indicate that this skill has file-system side effects and should only be invoked
by users, not by the AI model programmatically.
Sources: Coding guidelines, Learnings
There was a problem hiding this comment.
For future reference, this file auto-generates so does not need to be edited.
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)
plugins/react/README.md (1)
27-40:⚠️ Potential issue | 🟡 Minor | ⚡ Quick winKeep the agent filename aligned with the
pf-naming rule.The tree still shows
component-structure-audit.md, but the adjacent agent entry usespf-component-structure-audit. That breaks the repo convention and will point contributors at the wrong path if the agent was renamed.Fix
-│ ├── component-structure-audit.md +│ ├── pf-component-structure-audit.mdAs per coding guidelines, "The directory name, file name, and frontmatter name must all match."
🤖 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 `@plugins/react/README.md` around lines 27 - 40, The file structure tree in the README shows `component-structure-audit.md` under the agents directory, but this does not match the naming convention established in the agent reference above which uses `pf-component-structure-audit`. Update the filename in the agents directory listing from `component-structure-audit.md` to `pf-component-structure-audit.md` to align with the `pf-` naming prefix convention and ensure the directory name, file name, and frontmatter name all match as required by the coding guidelines.Source: Coding guidelines
🤖 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 `@plugins/react/README.md`:
- Around line 27-40: The file structure tree in the README shows
`component-structure-audit.md` under the agents directory, but this does not
match the naming convention established in the agent reference above which uses
`pf-component-structure-audit`. Update the filename in the agents directory
listing from `component-structure-audit.md` to `pf-component-structure-audit.md`
to align with the `pf-` naming prefix convention and ensure the directory name,
file name, and frontmatter name all match as required by the coding guidelines.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Run ID: 2e92381c-c207-45fa-8cda-b5dc0ace6068
📒 Files selected for processing (3)
PLUGINS.mdplugins/react/README.mdplugins/react/skills/pf-design-comments/SKILL.md
✅ Files skipped from review due to trivial changes (2)
- PLUGINS.md
- plugins/react/skills/pf-design-comments/SKILL.md
2 participants
Added ability to run patternfly design comment system via a skill.
Summary by CodeRabbit
New Features
Documentation