Add GitHub Copilot instructions for workshop app onboarding#75
Conversation
✅ Deploy Preview for workshop-order ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Co-authored-by: SmokeHound <23314326+SmokeHound@users.noreply.github.com>
|
I can see you've attached a
I can't directly access the attachment, so if you could share the content or specific changes you'd like me to make, I'll be happy to update the file accordingly. |
|
Important Review skippedBot user detected. To trigger a single review, invoke the You can disable this status message by setting the Comment |
There was a problem hiding this comment.
Pull Request Overview
This PR adds comprehensive GitHub Copilot instructions to help onboard developers and improve AI-generated code suggestions for a workshop management monorepo. The instructions provide detailed context about the repository structure, technology stack, and coding patterns to ensure consistent code generation.
Key changes:
- Creates a new GitHub Copilot instructions file with detailed repository documentation
- Documents architecture patterns including JWT authentication, role-based access control, and RESTful API design
- Provides code examples and security guidelines for both frontend and backend development
| - No build process - direct serving of static files | ||
|
|
||
| ### Database Design | ||
| - SQLite database with manual schema management |
There was a problem hiding this comment.
[nitpick] The term 'manual schema management' could be clearer. Consider specifying what this means (e.g., 'SQLite database with schema managed through direct SQL scripts' or 'SQLite database without automated migrations').
|
|
||
| ## Environment Configuration | ||
|
|
||
| Required environment variables (see `.env-example`): |
There was a problem hiding this comment.
[nitpick] The reference to .env-example assumes this file exists in the repository. Since this is documentation for Copilot instructions, it would be helpful to clarify the actual location of environment variable examples or remove the reference if the file doesn't exist.
There was a problem hiding this comment.
This PR adds comprehensive GitHub Copilot instructions to help onboard developers and improve code suggestions for the Workshop App monorepo.
What's Added
A new
.github/copilot-instructions.mdfile that provides GitHub Copilot with detailed context about:Why This Helps
With these instructions, GitHub Copilot will:
admin,user,tech)Example Benefits
When a developer starts typing:
Copilot will now suggest adding authentication and role checking:
This onboarding documentation ensures new contributors and AI assistance align with the project's architecture and best practices from day one.
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.