Skip to content

Commit 7dc0248

Browse files
Merge branch 'mstoyanova/update-skills-build' of https://github.com/IgniteUI/igniteui-cli into mstoyanova/update-skills-build
2 parents ba69114 + a5cb495 commit 7dc0248

5 files changed

Lines changed: 157 additions & 3 deletions

File tree

Lines changed: 89 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,89 @@
1+
# LLM Agent Skills for Ignite UI for React
2+
3+
This directory contains skills for GitHub Copilot and other LLM agents to help developers use **Ignite UI for React** effectively in their applications.
4+
5+
## What are Skills?
6+
7+
Skills are structured instructions that help AI agents understand and execute common tasks consistently. Each skill is a self-contained guide that provides step-by-step instructions, code examples, and best practices — all specific to React and the `igniteui-react` family of packages.
8+
9+
## Available Skills
10+
11+
| Skill | Description | Use When |
12+
| --- | --- | --- |
13+
| [igniteui-react-components](./igniteui-react-components/SKILL.md) | Identify the right React components (`Igr*`) for a UI pattern, then install, import, and use them — JSX patterns, events, refs, forms | Choosing components or setting up and using them in React |
14+
| [igniteui-react-customize-theme](./igniteui-react-customize-theme/SKILL.md) | Customize styling using CSS custom properties, Sass, and the theming system in a React context | Applying custom brand colors/styles |
15+
| [igniteui-react-optimize-bundle-size](./igniteui-react-optimize-bundle-size/SKILL.md) | Reduce bundle size with granular imports, tree-shaking, and lazy loading | Optimizing production performance |
16+
17+
## How to Use
18+
19+
When working with an AI agent like GitHub Copilot, reference skills by name or ask questions naturally:
20+
21+
### Natural Questions
22+
23+
- "How do I add a data grid to my React app?"
24+
- "What Ignite UI component should I use for a date picker?"
25+
- "Help me customize the button colors to match my brand"
26+
- "My bundle size is too large, how can I reduce it?"
27+
- "How do I handle events on IgrCombo?"
28+
29+
### Direct Skill Reference
30+
31+
- "Follow the igniteui-react-components skill for setting up my project"
32+
- "Use the igniteui-react-customize-theme skill to help me style components"
33+
- "Apply the igniteui-react-optimize-bundle-size skill to reduce my bundle"
34+
35+
## Skill Structure
36+
37+
Each skill contains:
38+
39+
- **Example Usage**: Common questions or scenarios
40+
- **When to Use**: Situations where the skill applies
41+
- **Related Skills**: Other relevant skills to explore
42+
- **Step-by-Step Instructions**: Detailed guidance with code examples
43+
- **Common Issues & Solutions**: Troubleshooting guidance
44+
- **Best Practices**: Recommended approaches
45+
- **Additional Resources**: Further reading and documentation
46+
47+
## Editor / Agent Setup
48+
49+
Most modern AI assistants (GitHub Copilot, Cursor, Windsurf, Claude Code, etc.) should auto-discover these skills from a specified location in the workspace or global profile.
50+
51+
For example, you can copy them into the agent-specific skills folder for your editor:
52+
53+
### GitHub Copilot
54+
55+
Copy the skill files into your project's `.agents/skills/` directory:
56+
57+
```
58+
.agents/
59+
skills/
60+
igniteui-react-components/
61+
SKILL.md
62+
reference/
63+
igniteui-react-customize-theme/
64+
SKILL.md
65+
reference/
66+
igniteui-react-optimize-bundle-size/
67+
SKILL.md
68+
```
69+
70+
### Claude Code
71+
72+
Copy the skill files into your project's `.claude/skills/` directory:
73+
74+
```
75+
.claude/
76+
skills/
77+
igniteui-react-components/
78+
SKILL.md
79+
reference/
80+
igniteui-react-customize-theme/
81+
SKILL.md
82+
reference/
83+
igniteui-react-optimize-bundle-size/
84+
SKILL.md
85+
```
86+
87+
### Other Agents (Cursor, Windsurf, etc.)
88+
89+
Consult your agent's documentation for the correct skills directory path and copy the skill files there. The skill structure is agent-agnostic — any assistant that supports skill files can use them directly.
Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
# LLM Agent Skills for End Users
2+
3+
This directory contains skills for GitHub Copilot and other LLM agents to help developers use Ignite UI Web Components effectively in their applications.
4+
5+
## What are Skills?
6+
7+
Skills are structured instructions that help AI agents understand and execute common tasks consistently. Each skill is a self-contained guide that provides step-by-step instructions, code examples, and best practices.
8+
9+
## Available Skills
10+
11+
| Skill | Description | Use When |
12+
| ----------------------------------------------------------- | ---------------------------------------------------------------------------------- | ------------------------------------- |
13+
| [igniteui-wc-choose-components](./igniteui-wc-choose-components/SKILL.md) | Identify the right components for a UI pattern and navigate to official docs/demos | Deciding which components to use |
14+
| [igniteui-wc-integrate-with-framework](./igniteui-wc-integrate-with-framework/SKILL.md) | Integrate components into React, Angular, Vue, or vanilla JS applications | Setting up components in your project |
15+
| [igniteui-wc-customize-component-theme](./igniteui-wc-customize-component-theme/SKILL.md) | Customize styling using CSS custom properties, parts, and theming system | Applying custom brand colors/styles |
16+
| [igniteui-wc-optimize-bundle-size](./igniteui-wc-optimize-bundle-size/SKILL.md) | Reduce bundle size by importing only needed components and lazy loading | Optimizing production performance |
17+
18+
## How to Use
19+
20+
When working with an AI agent like GitHub Copilot, reference skills by name or ask questions naturally:
21+
22+
### Natural Questions
23+
- "How do I integrate igniteui-webcomponents with React?"
24+
- "Help me customize the button colors to match my brand"
25+
- "My bundle size is too large, how can I reduce it?"
26+
- "Show me how to use these components in Vue"
27+
28+
### Direct Skill Reference
29+
- "Follow the integrate-with-framework skill for my Angular app"
30+
- "Use the customize-component-theme skill to help me style components"
31+
- "Apply the optimize-bundle-size skill to reduce my bundle"
32+
33+
## Skill Structure
34+
35+
Each skill contains:
36+
37+
- **Example Usage**: Common questions or scenarios
38+
- **When to Use**: Situations where the skill applies
39+
- **Related Skills**: Other relevant skills to explore
40+
- **Step-by-Step Instructions**: Detailed guidance with code examples
41+
- **Framework-Specific Examples**: React, Angular, Vue, and vanilla JS patterns
42+
- **Common Issues & Solutions**: Troubleshooting guidance
43+
- **Best Practices**: Recommended approaches
44+
- **Additional Resources**: Further reading and documentation
45+
46+
## Contributing
47+
48+
If you identify gaps in the skills or have suggestions for improvements:
49+
50+
1. [Open an issue](https://github.com/IgniteUI/igniteui-webcomponents/issues) describing the improvement
51+
2. Submit a pull request with the proposed changes
52+
3. Follow the skill format and structure of existing skills
53+
54+
For skills related to **contributing to the library itself** (creating components, reviewing PRs, etc.), see [`.github/skills/`](../.github/skills/).
55+
56+
## Additional Resources
57+
58+
- [Component Documentation](https://igniteui.github.io/igniteui-webcomponents)
59+
- [Project README](../README.md)
60+
- [Code Examples & Storybook](https://igniteui.github.io/igniteui-webcomponents)
61+
- [GitHub Repository](https://github.com/IgniteUI/igniteui-webcomponents)
62+
63+
## License
64+
65+
These skills are provided under the same license as the Ignite UI Web Components library. See [LICENSE](../LICENSE) for details.
Submodule igniteui-react updated 34 files

0 commit comments

Comments
 (0)