-
Notifications
You must be signed in to change notification settings - Fork 464
Add comprehensive guides for various Epic Stack skills #1078
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
- Introduced new SKILL.md files covering authentication, caching, database management, deployment, forms, permissions, React best practices, routing, security, testing, and UI guidelines. - Each guide includes usage scenarios, patterns, conventions, common mistakes, and references to enhance developer understanding and implementation of best practices in the Epic Stack.
|
Thank you for putting this together. Do you think it would be better to place the skill folders inside a |
|
Hey Cris! Thanks for the suggestion, that makes a lot of sense I initially placed the skills under .cursor mainly because the folder already existed and felt like a natural starting point. That said, I totally agree that .github/skills/ at the repo root is probably a better, more discoverable convention for agents across Cursor, Claude Code, Copilot, and others. Happy to move them there if you think that’s the right call, no problem at all on my side. Let me know what you prefer and I’ll adjust it. |
|
please place the skills in |
|
Is there no standard place to put these? Will putting them in |
Co-authored-by: Sergio Xalambrí <hello@sergiodxa.com>
|
There’s no official standard yet for where AI agent rules/skills should live, but the emerging convention is to keep shared, tool-agnostic instructions in .github/ (e.g. .github/skills/ or .github/ai/). This makes them discoverable by multiple agents and avoids editor/vendor lock-in. @kentcdodds Kent, could you confirm whether you’d prefer this to live under .github/ (e.g. .github/skills/), or if you’d suggest a better location? I’m happy to adjust it to match whatever you think works best. |
|
From what I understand, any |
|
I like |
- Relocate all skill guides from .cursor/skills/ to docs/skills/ - Rename epic-react-best-practices to epic-react-patterns
|
The change is ready 👍 |
|
Right now we delete the docs directory when initializing the project. I think we should probably not do that anymore in general, and we'll definitely not want to do that for these skills. Could you remove that bit in the init script? |
- Eliminated the removal of the 'docs' directory from the cleanup process in the main function.
|
The change is ready 🔥 |
kentcdodds
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Awesome! Let's see how it goes 🤞
|
Thanks a ton for putting these together! |
Summary
This PR adds 11 comprehensive skill guides (
SKILL.mdfiles) to.cursor/skills/that document Epic Stack best practices and patterns. Each guide includes when to use it, patterns, conventions, common mistakes, and references.Guides added:
epic-auth: Authentication, sessions, OAuth, 2FA, and passkeysepic-caching: Caching with cachified, SQLite cache, and LRU cacheepic-database: Prisma, SQLite, and LiteFSepic-deployment: Deployment with Fly.io, multi-region setup, and CI/CDepic-forms: Forms with Conform and validation with Zodepic-permissions: RBAC system and permissionsepic-react-patterns: React patterns, performance optimization, and code qualityepic-routing: Routing with React Router and react-router-auto-routesepic-security: Security practices including CSP, rate limiting, and session securityepic-testing: Testing with Vitest and Playwrightepic-ui-guidelines: UI/UX guidelines, accessibility, and component usageThese guides serve as comprehensive references to help developers understand and implement Epic Stack best practices and conventions.
Test Plan
No tests required because:
docs/skills/*/SKILL.md)Suggested verification steps:
SKILL.mdfiles exist indocs/skills/Checklist
Screenshots
N/A - Only documentation files were added.