Skip to content

Commit 3148e91

Browse files
HugoRCDHugoRCD
committed
up
1 parent b9b799b commit 3148e91

File tree

3 files changed

+244
-7
lines changed

3 files changed

+244
-7
lines changed

‎.github/ISSUE_TEMPLATE/ai-hallucination.yml

Lines changed: 120 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,120 @@
1+
name: 🤖 AI Hallucination Report
2+
description: Report incorrect Nuxt UI v3 code generated by AI assistants
3+
title: "[AI Bug] "
4+
labels: ["ai-hallucination", "bug"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for helping improve Nuxt UI v3 guidelines! This helps us prevent AI assistants from making the same mistakes.
10+
11+
- type: dropdown
12+
id: ai-assistant
13+
attributes:
14+
label: 🤖 AI Assistant
15+
description: Which AI assistant generated the incorrect code?
16+
options:
17+
- Cursor
18+
- Claude (Anthropic)
19+
- ChatGPT (OpenAI)
20+
- GitHub Copilot
21+
- Codeium
22+
- Windsurf
23+
- Other
24+
validations:
25+
required: true
26+
27+
- type: input
28+
id: ai-version
29+
attributes:
30+
label: AI Version
31+
description: If known, specify the version or model
32+
placeholder: e.g., Claude 3.5 Sonnet, GPT-4, etc.
33+
34+
- type: textarea
35+
id: problem-description
36+
attributes:
37+
label: 🚨 Problem Description
38+
description: Briefly describe what the AI generated incorrectly
39+
placeholder: e.g., "AI used UDropdown instead of UDropdownMenu"
40+
validations:
41+
required: true
42+
43+
- type: textarea
44+
id: generated-code
45+
attributes:
46+
label: ❌ Generated Code (Incorrect)
47+
description: Paste the incorrect code generated by the AI
48+
placeholder: |
49+
```vue
50+
<!-- Paste the incorrect code here -->
51+
```
52+
render: vue
53+
validations:
54+
required: true
55+
56+
- type: textarea
57+
id: expected-code
58+
attributes:
59+
label: ✅ Expected Code (Correct)
60+
description: Paste what the AI should have generated instead
61+
placeholder: |
62+
```vue
63+
<!-- Paste the correct code here -->
64+
```
65+
render: vue
66+
validations:
67+
required: true
68+
69+
- type: textarea
70+
id: prompt-used
71+
attributes:
72+
label: 🎯 Prompt Used
73+
description: Paste the prompt you gave to the AI that led to the incorrect generation
74+
placeholder: What did you ask the AI to do?
75+
validations:
76+
required: true
77+
78+
- type: checkboxes
79+
id: rules-context
80+
attributes:
81+
label: 📋 Rules Context
82+
description: Were you using our Nuxt UI rules?
83+
options:
84+
- label: I was using the Complete rules (nuxt-ui.md)
85+
- label: I was using the Minimal rules (nuxt-ui-minimal.md)
86+
- label: I was NOT using any rules
87+
- label: I'm not sure
88+
89+
- type: dropdown
90+
id: project-type
91+
attributes:
92+
label: 🏗️ Project Type
93+
description: What type of project were you working on?
94+
options:
95+
- New Nuxt UI v3 project
96+
- Migration from Nuxt UI v2
97+
- Existing project adding components
98+
- Learning/Testing
99+
- Other
100+
validations:
101+
required: true
102+
103+
- type: checkboxes
104+
id: suggested-fix
105+
attributes:
106+
label: 💡 Suggested Fix
107+
description: If you know which rule could prevent this, please suggest
108+
options:
109+
- label: Add new rule to prevent this issue
110+
- label: Improve existing rule with better explanation
111+
- label: Add more examples to existing rule
112+
- label: Update breaking changes section
113+
- label: Add common mistake warning
114+
115+
- type: textarea
116+
id: additional-context
117+
attributes:
118+
label: 📝 Additional Context
119+
description: Any other details that might help us improve the rules
120+
placeholder: Optional - anything else that might be relevant

‎.github/ISSUE_TEMPLATE/rule-improvement.yml

Lines changed: 114 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,114 @@
1+
name: 💡 Rule Improvement
2+
description: Suggest improvements to existing rules or request new ones
3+
title: "[Rule] "
4+
labels: ["enhancement"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Help us improve the Nuxt UI v3 guidelines! Your suggestions make the rules better for everyone.
10+
11+
- type: dropdown
12+
id: improvement-type
13+
attributes:
14+
label: 🎯 Type of Improvement
15+
description: What kind of improvement are you suggesting?
16+
options:
17+
- Missing rule for new Nuxt UI v3 feature
18+
- Unclear or confusing existing rule
19+
- Missing examples in existing rule
20+
- Rule doesn't work well with specific AI
21+
- Add common mistake warning
22+
- Improve component documentation
23+
- Better TypeScript examples
24+
- Performance optimization rule
25+
- Accessibility improvement
26+
- Other
27+
validations:
28+
required: true
29+
30+
- type: dropdown
31+
id: rule-section
32+
attributes:
33+
label: 📖 Rule Section (if applicable)
34+
description: Which section of the rules needs improvement?
35+
options:
36+
- Installation & Setup
37+
- Component Renames
38+
- Removed Components
39+
- Prop Changes
40+
- Event Handling
41+
- Overlay Patterns
42+
- Design System & Tokens
43+
- Theming & Styling
44+
- Performance Best Practices
45+
- TypeScript Integration
46+
- Accessibility
47+
- Common Mistakes
48+
- Examples
49+
- Not applicable (new rule)
50+
- Other
51+
52+
- type: textarea
53+
id: problem-description
54+
attributes:
55+
label: 🚨 Problem
56+
description: Describe what's missing, unclear, or needs improvement
57+
placeholder: e.g., "The overlay pattern section doesn't show how to handle form validation"
58+
validations:
59+
required: true
60+
61+
- type: textarea
62+
id: proposed-solution
63+
attributes:
64+
label: 💡 Proposed Solution
65+
description: What would you add or change? Include code examples if possible
66+
placeholder: |
67+
Describe your proposed improvement...
68+
69+
```vue
70+
<!-- Example of improved rule/pattern -->
71+
```
72+
validations:
73+
required: true
74+
75+
- type: checkboxes
76+
id: ai-testing
77+
attributes:
78+
label: 🤖 AI Testing
79+
description: Have you tested this improvement with AI assistants?
80+
options:
81+
- label: Tested with Cursor - works well
82+
- label: Tested with Claude - works well
83+
- label: Tested with ChatGPT - works well
84+
- label: Tested with GitHub Copilot - works well
85+
- label: Tested with other AI - works well
86+
- label: Tested but still has issues
87+
- label: Not tested yet
88+
89+
- type: dropdown
90+
id: priority
91+
attributes:
92+
label: 📈 Priority Level
93+
description: How important is this improvement?
94+
options:
95+
- Critical (AI frequently makes this mistake)
96+
- High (Common issue affecting many users)
97+
- Medium (Useful improvement)
98+
- Low (Nice to have)
99+
validations:
100+
required: true
101+
102+
- type: input
103+
id: nuxt-ui-docs
104+
attributes:
105+
label: 🔗 Nuxt UI Documentation Reference
106+
description: Link to relevant Nuxt UI docs (if applicable)
107+
placeholder: https://ui.nuxt.com/...
108+
109+
- type: textarea
110+
id: additional-context
111+
attributes:
112+
label: 📝 Additional Context
113+
description: Any other details, related issues, or examples
114+
placeholder: Optional - links to related issues, additional examples, etc.

‎README.md

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -26,13 +26,16 @@ We provide two versions of Nuxt UI rules to fit different needs:
2626

2727
## Using with Cursor
2828

29-
To integrate these guidelines with Cursor, follow these steps:
30-
31-
1. Create a new file named `nuxt-ui.mdc` inside the `.cursor/rules/` directory of your project.
32-
33-
2. Copy the complete content from your chosen rule file:
34-
- **Complete**: Copy everything from [nuxt-ui.md](https://github.com/hugorcd/nuxt-ui-rules/blob/main/rules/nuxt-ui.md?plain=1)
35-
- **Minimal**: Copy everything from [nuxt-ui-minimal.md](https://github.com/hugorcd/nuxt-ui-rules/blob/main/rules/nuxt-ui-minimal.md?plain=1)
29+
**Option 1 - Via Settings Interface (Recommended)** 🎯
30+
1. Open Cursor Settings (`Cmd/Ctrl + ,`)
31+
2. Navigate to **"Rules for AI"** tab
32+
3. Copy and paste your chosen rule content:
33+
- **Complete**: Copy from [nuxt-ui.md](https://github.com/hugorcd/nuxt-ui-rules/blob/main/rules/nuxt-ui.md?plain=1)
34+
- **Minimal**: Copy from [nuxt-ui-minimal.md](https://github.com/hugorcd/nuxt-ui-rules/blob/main/rules/nuxt-ui-minimal.md?plain=1)
35+
36+
**Option 2 - Via File Configuration**
37+
1. Create `.cursor/rules/nuxt-ui.mdc` in your project root
38+
2. Copy your chosen rule content into this file
3639

3740
## Using with Claude Code
3841

0 commit comments

Comments
 (0)