Skip to content

docs: add AI Agent Skills Framework to registry - #310

Closed
luoning wants to merge 4 commits into
PatrickJS:mainfrom
luoning:main
Closed

luoning wants to merge 4 commits into
PatrickJS:mainfrom
luoning:main

Conversation

@luoning

@luoning luoning commented Jun 12, 2026 •

Copy link
Copy Markdown

Description

Added AI Agent Skills Framework to the rules ecosystem.

Unlike standard static styling rules, this framework introduces:

  1. Physical State Lock (.pipeline_state.json) to prevent agent task evasion.
  2. Automated DoD checker (pipeline_validator.py) to physically block inline colors and styling leaks.
  3. Native Cursor MDC rules compiler (generate_mdc.py) and a Runtime self-healing loop.

Highly aligned with the mission of standardizing agentic workflows!

Summary by CodeRabbit

  • Documentation
    • Renamed Mobile Development entry from "SwiftUI Guidelines" to "SwiftGuidelines" and updated its one-line description.
    • Minor formatting: added a blank line before the State Management section header.
    • Added a new rule document describing staged execution tied to pipeline state, strict CSS decoupling (no raw colors/inline styles), a self‑healing retry flow (up to 3 attempts) and default disabled application.

@coderabbitai

coderabbitai Bot commented Jun 12, 2026 •

Copy link
Copy Markdown
Contributor

Review Change Stack

📝 Walkthrough

Walkthrough

Two independent edits: README.md updates rename the Mobile Development Swift entry and add a blank line before the State Management header; a new rule file rules/ai-agent-skills-framework.mdc was added defining applicability globs, execution sequencing, CSS isolation verification, and bounded self-healing behavior.

Changes

Documentation list updates

Layer / File(s) Summary
README list edits and spacing
README.md
Renamed “SwiftUI Guidelines” → “SwiftGuidelines” in Mobile Development; inserted a blank line between “CSS and Styling” and “State Management”.

New rule: ai-agent-skills-framework

Layer / File(s) Summary
Rule definition and applicability
rules/ai-agent-skills-framework.mdc
Adds a rule scoped to HTML/CSS/JS via globs, default alwaysApply: false, and requirements: pipeline-state staged execution tied to .pipeline_state.json, CSS decoupling with verification via python scripts/pipeline_validator.py, and up-to-3 self-healing retries before human escalation.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Possibly related PRs

Poem

🐰 I hopped through lines with cheerful paws,

SwiftGuidelines now tucked in cause,
A tiny gap I left between,
And a new rule to watch the scene,
Happy hops for tidy laws.

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The description is missing required sections from the template including Contribution Type checkboxes, Value To Cursor Users, Added Or Changed Files, and the Quality Checklist. Complete all required sections from the template: select appropriate contribution type, explain user value, list changed files with reasons, and verify quality checklist items.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately reflects the main change: adding the AI Agent Skills Framework rule to the registry.
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.

✏️ 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.

@coderabbitai coderabbitai Bot left a comment

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.

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 `@README.md`:
- Line 169: The README entry uses the broken label "SwiftGuidelines" and typo'd
description "Swiftdevelopment" while linking to swiftui-guidelines; update the
entry so the link text and description accurately reflect the resource (e.g.,
change "SwiftGuidelines" to "SwiftUI Guidelines" and "Swiftdevelopment
guidelines." to "SwiftUI development guidelines."), and ensure the link still
points to the existing swiftui-guidelines file/URL so the name, description, and
target are consistent.
🪄 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: defaults

Review profile: CHILL

Plan: Pro

Run ID: 04c0b0d8-01a6-4220-ba1e-f9300ccb57b0

📥 Commits

Reviewing files that changed from the base of the PR and between b044f95 and ec5e911.

📒 Files selected for processing (1)
  • README.md

Comment thread README.md
- [NativeScript](https://github.com/PatrickJS/awesome-cursorrules/blob/main/rules/nativescript-cursorrules-prompt-file.mdc) - Cross-platform mobile app development.
- [React Native Expo](https://github.com/PatrickJS/awesome-cursorrules/blob/main/rules/react-native-expo-cursorrules-prompt-file.mdc) - Expo-based mobile app development.
- [SwiftUI Guidelines](https://github.com/PatrickJS/awesome-cursorrules/blob/main/rules/swiftui-guidelines-cursorrules-prompt-file.mdc) - SwiftUI development guidelines.
- [SwiftGuidelines](https://github.com/PatrickJS/awesome-cursorrules/blob/main/rules/swiftui-guidelines-cursorrules-prompt-file.mdc) - Swiftdevelopment guidelines.

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 | 🟡 Minor | ⚡ Quick win

Fix the README label/description typo.

SwiftGuidelines and Swiftdevelopment read like accidental text corruption, and the link still targets swiftui-guidelines. Keep the entry name and description aligned with the actual resource.

♻️ Proposed fix
- [SwiftGuidelines](https://github.com/PatrickJS/awesome-cursorrules/blob/main/rules/swiftui-guidelines-cursorrules-prompt-file.mdc) - Swiftdevelopment guidelines.
+ [SwiftUI Guidelines](https://github.com/PatrickJS/awesome-cursorrules/blob/main/rules/swiftui-guidelines-cursorrules-prompt-file.mdc) - Swift development guidelines.
📝 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.

Suggested change
- [SwiftGuidelines](https://github.com/PatrickJS/awesome-cursorrules/blob/main/rules/swiftui-guidelines-cursorrules-prompt-file.mdc) - Swiftdevelopment guidelines.
- [SwiftUI Guidelines](https://github.com/PatrickJS/awesome-cursorrules/blob/main/rules/swiftui-guidelines-cursorrules-prompt-file.mdc) - Swift development guidelines.
🤖 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 `@README.md` at line 169, The README entry uses the broken label
"SwiftGuidelines" and typo'd description "Swiftdevelopment" while linking to
swiftui-guidelines; update the entry so the link text and description accurately
reflect the resource (e.g., change "SwiftGuidelines" to "SwiftUI Guidelines" and
"Swiftdevelopment guidelines." to "SwiftUI development guidelines."), and ensure
the link still points to the existing swiftui-guidelines file/URL so the name,
description, and target are consistent.

Add the contract-driven AI Agent Skills Framework to the Build Tools and Development section, maintaining strict alphabetical order.

@coderabbitai coderabbitai Bot left a comment

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.

♻️ Duplicate comments (1)
README.md (1)

169-169: ⚠️ Potential issue | 🟡 Minor | ⚡ Quick win

Restore the SwiftUI label/description.

This still reads like a text corruption (SwiftGuidelines / Swiftdevelopment) and no longer matches the linked resource name.

🤖 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 `@README.md` at line 169, The README list item uses a corrupted label/text
("SwiftGuidelines" and "Swiftdevelopment guidelines") that doesn't match the
linked resource; update the markdown list entry so the link text and description
match the linked file name and intent (for example change
`[SwiftGuidelines](https://github.com/PatrickJS/awesome-cursorrules/blob/main/rules/swiftui-guidelines-cursorrules-prompt-file.mdc)
- Swiftdevelopment guidelines.` to something like `SwiftUI Guidelines - SwiftUI
development guidelines.`), ensuring the visible link text and the short
description correctly reference "SwiftUI Guidelines" and the linked resource.
🤖 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.

Duplicate comments:
In `@README.md`:
- Line 169: The README list item uses a corrupted label/text ("SwiftGuidelines"
and "Swiftdevelopment guidelines") that doesn't match the linked resource;
update the markdown list entry so the link text and description match the linked
file name and intent (for example change
`[SwiftGuidelines](https://github.com/PatrickJS/awesome-cursorrules/blob/main/rules/swiftui-guidelines-cursorrules-prompt-file.mdc)
- Swiftdevelopment guidelines.` to something like `SwiftUI Guidelines - SwiftUI
development guidelines.`), ensuring the visible link text and the short
description correctly reference "SwiftUI Guidelines" and the linked resource.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 6a8d1911-59ff-4d0f-b988-598d81f0194b

📥 Commits

Reviewing files that changed from the base of the PR and between ec5e911 and cf742ce.

📒 Files selected for processing (1)
  • README.md

@coderabbitai coderabbitai Bot left a comment

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.

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)
rules/ai-agent-skills-framework.mdc (1)

13-20: ⚠️ Potential issue | 🟠 Major | ⚡ Quick win

Close the bash fence here.

The fenced code block opened for python scripts/pipeline_validator.py is never terminated, so the self-healing requirement and the link below are swallowed into the code block instead of being part of the rule text.

Suggested fix
  ```bash
  python scripts/pipeline_validator.py
+ ```
  3. Self-Healing: Run diagnostic healing up to 3 times upon runtime errors before requesting human help.
🤖 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 `@rules/ai-agent-skills-framework.mdc` around lines 13 - 20, The markdown fence
for the inline bash example in rules/ai-agent-skills-framework.mdc is not
closed, so fix the block that starts with the line containing "python
scripts/pipeline_validator.py" by adding a closing triple-backtick (```)
immediately after that command (or converting the opening line to a proper
fenced block with "```bash" and then closing it); ensure the subsequent "3.
Self-Healing..." bullet and the link are plain text outside the fenced code
block so they render correctly.
🤖 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 `@rules/ai-agent-skills-framework.mdc`:
- Around line 13-20: The markdown fence for the inline bash example in
rules/ai-agent-skills-framework.mdc is not closed, so fix the block that starts
with the line containing "python scripts/pipeline_validator.py" by adding a
closing triple-backtick (```) immediately after that command (or converting the
opening line to a proper fenced block with "```bash" and then closing it);
ensure the subsequent "3. Self-Healing..." bullet and the link are plain text
outside the fenced code block so they render correctly.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: da821ac1-ff34-4606-a174-b8228a98e5f5

📥 Commits

Reviewing files that changed from the base of the PR and between 723450c and 36fe2fc.

📒 Files selected for processing (1)
  • rules/ai-agent-skills-framework.mdc

@luoning luoning closed this by deleting the head repository Jun 12, 2026
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