✨ First attempt at adding rules and skills

[jmle]

Adding rules and skills to improve context. Ideally this should aid with AI rule creation.

Summary by CodeRabbit

• Documentation
  • Added comprehensive guides for creating rules and managing tests
  • Introduced step-by-step workflows for contributors (create rules, add/update tests, run tests)
  • Updated directory structure guidance and contribution standards
  • Documented rule and test file formats with format conventions and best practices

[coderabbitai]

📝 Walkthrough

Walkthrough

This pull request introduces comprehensive documentation for integrating Cursor rules and skills into the repository. It adds format specifications for rule and test YAML files, workflow guides for creating rules and running tests, reorganizes directory structure guidance in CONTRIBUTING.md, and includes a design plan document outlining the overall integration strategy.

Changes

Cohort / File(s)	Summary
Rule and Test Format Specifications .cursor/rules/rule-format-and-conventions.mdc, .cursor/rules/test-format-and-conventions.mdc	Documents canonical YAML schemas for rule definitions and test files, including when-condition providers, field structures, and best practices.
Workflow Skills Guides .cursor/skills/create-new-rule.md, .cursor/skills/add-or-update-tests.md, .cursor/skills/run-rule-tests.md	Step-by-step guidance for developers on creating new rules, adding/updating tests, and running rule tests locally with Kantra.
Repository Structure and Planning CONTRIBUTING.md, docs/CURSOR_RULES_AND_SKILLS_PLAN.md	Updates directory structure guidance to reflect stable/preview hierarchy organized by language and technology; provides design plan for Cursor rules/skills integration with reference architecture and implementation roadmap.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Poem

🐰 A garden of rules, now clearly drawn,
With schemas and skills to guide us on,
From Cursor's quill, the docs take flight,
Testing and building—all done right! 🌱

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name	Status	Explanation	Resolution
Title check	❓ Inconclusive	The title uses an emoji and vague phrasing ('First attempt at adding rules and skills') that doesn't clearly convey the specific nature of the changes.	Replace with a more descriptive title that specifically mentions what rules and skills are being added, such as: 'Add Cursor rules and skills documentation for rule creation and testing workflows.'

✅ Passed checks (2 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
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

• X
• Mastodon
• Reddit
• LinkedIn

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

[coderabbitai]

🧹 Nitpick comments (2)

docs/CURSOR_RULES_AND_SKILLS_PLAN.md (1)

1-5: Clarify the document's status since the plan is being implemented in this PR.

The document states "No rules or skills are created by this plan; it is a design and scoping note for when we implement them" (line 3), but this same PR is actually implementing all the described rules and skills (adding .cursor/rules/*.mdc and .cursor/skills/*.md files). This creates potential confusion for future readers about whether this is a historical planning document or current guidance.

💡 Suggested clarification

Consider adding a note to clarify the implementation status:

 # Plan: Cursor Rules and Skills for Konveyor Rulesets
 
-This document outlines what would be done to add **Cursor rules** (reference context) and **Cursor skills** (task workflows) to this repository. No rules or skills are created by this plan; it is a design and scoping note for when we implement them.
+This document outlines the design for adding **Cursor rules** (reference context) and **Cursor skills** (task workflows) to this repository. 
+
+**Status:** This plan has been implemented as of PR `#360`. The actual rules and skills are located in `.cursor/rules/` and `.cursor/skills/`.

Alternatively, convert future tense descriptions throughout the document to present tense to reflect that it's implemented.

🤖 Prompt for AI Agents

Verify each finding against the current code and only fix it if needed.

In `@docs/CURSOR_RULES_AND_SKILLS_PLAN.md` around lines 1 - 5, Update the status
sentence that currently reads "No rules or skills are created by this plan; it
is a design and scoping note for when we implement them" to reflect that the
plan has been implemented in this PR—either replace it with a short note like
"This plan has been implemented in this PR; corresponding rules and skills were
added under .cursor/rules and .cursor/skills" or change the document's verbs
from future to present tense throughout so the doc reads as current guidance;
ensure the new text clearly states implementation and points to the added
artifacts.

.cursor/rules/rule-format-and-conventions.mdc (1)

17-17: Consider removing or updating this note since CONTRIBUTING.md is being updated in this PR.

Line 17 states that CONTRIBUTING.md "still mentions default/generated", but CONTRIBUTING.md is being updated in this same PR (lines 39-62) to reflect the stable/ and preview/ structure. This note will be outdated as soon as the PR merges and may cause confusion.

📝 Suggested update

Either remove the note entirely, or rephrase it to acknowledge the alignment:

-  - **Note:** CONTRIBUTING.md still mentions `default/generated`; the repo uses **`stable/`** and **`preview/`** — follow the current layout.
+  - Directory structure is documented in CONTRIBUTING.md under `stable/` and `preview/`.

🤖 Prompt for AI Agents

Verify each finding against the current code and only fix it if needed.

In @.cursor/rules/rule-format-and-conventions.mdc at line 17, Remove or update
the note in rule-format-and-conventions.mdc that claims CONTRIBUTING.md "still
mentions `default/generated`" because the same PR updates CONTRIBUTING.md to use
`stable/` and `preview/`; either delete that note or rephrase it to say
CONTRIBUTING.md in this PR has been updated to the current `stable/` and
`preview/` layout (reference the note text in rule-format-and-conventions.mdc
and the CONTRIBUTING.md changes in this PR).

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Nitpick comments:
In @.cursor/rules/rule-format-and-conventions.mdc:
- Line 17: Remove or update the note in rule-format-and-conventions.mdc that
claims CONTRIBUTING.md "still mentions `default/generated`" because the same PR
updates CONTRIBUTING.md to use `stable/` and `preview/`; either delete that note
or rephrase it to say CONTRIBUTING.md in this PR has been updated to the current
`stable/` and `preview/` layout (reference the note text in
rule-format-and-conventions.mdc and the CONTRIBUTING.md changes in this PR).

In `@docs/CURSOR_RULES_AND_SKILLS_PLAN.md`:
- Around line 1-5: Update the status sentence that currently reads "No rules or
skills are created by this plan; it is a design and scoping note for when we
implement them" to reflect that the plan has been implemented in this PR—either
replace it with a short note like "This plan has been implemented in this PR;
corresponding rules and skills were added under .cursor/rules and
.cursor/skills" or change the document's verbs from future to present tense
throughout so the doc reads as current guidance; ensure the new text clearly
states implementation and points to the added artifacts.

---

ℹ️ Review info

Configuration used: defaults

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 4f960a9 and 5787eed.

📒 Files selected for processing (7)

• .cursor/rules/rule-format-and-conventions.mdc
• .cursor/rules/test-format-and-conventions.mdc
• .cursor/skills/add-or-update-tests.md
• .cursor/skills/create-new-rule.md
• .cursor/skills/run-rule-tests.md
• CONTRIBUTING.md
• docs/CURSOR_RULES_AND_SKILLS_PLAN.md