-
Notifications
You must be signed in to change notification settings - Fork 7
chore: GitHub Copilot settings and guidelines #2432
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
base: main
Are you sure you want to change the base?
Conversation
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.
Pull Request Overview
This PR reorganizes dependency declarations and introduces standardized GitHub Copilot configuration and references across the project.
- Reorganized project dependencies and cleaned up unused packages.
- Added VS Code Copilot settings and a team-wide Copilot guideline document.
- Updated entry points and README to reference the new Copilot guidance.
Reviewed Changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 1 comment.
Show a summary per file
File | Description |
---|---|
frontend/src/main.tsx | Added a header comment linking to Copilot guidelines |
backend/src/app.ts | Inserted a comment block referencing Copilot guidelines |
README.md | Added a Development section with Copilot instructions |
.vscode/settings.json | Introduced Copilot and spell-checker configurations |
.github/copilot/COPILOT.md | Created comprehensive team guidelines for Copilot usage |
Comments suppressed due to low confidence (4)
README.md:63
- Adjust the link to use a relative path that resolves correctly in rendered markdown, e.g.,
./.github/copilot/COPILOT.md
.
1. Review our [Copilot Guidelines](.github/copilot/COPILOT.md) before contributing
frontend/src/main.tsx:3
- [nitpick] Consider using a relative path without a leading slash (e.g.,
../.github/copilot/COPILOT.md
) so the reference remains correct in different contexts.
* @see /.github/copilot/COPILOT.md for AI-assistance guidelines
.github/copilot/COPILOT.md:103
- The header contains an invalid or missing emoji placeholder (
�
). Replace it with the intended emoji or remove it to ensure proper rendering.
## � Language-Specific Guidelines
backend/src/app.ts:14
- There’s an extra
*
and duplicate closing*/
after the comment header. Remove the stray*
on this line and the following*/
to properly close the JSDoc block only once.
*
Configure GitHub Copilot Settings and Guidelines
Description
Add standardized GitHub Copilot configuration and guidelines to improve developer experience and ensure consistent code quality across the team.
Changes
VS Code Settings
Added
.vscode/settings.json
:Copilot Guidelines
Created
.github/copilot/COPILOT.md
with:Testing
✅ VS Code settings validated:
✅ Documentation verified:
Additional Context
These changes establish a foundation for AI-assisted development while ensuring:
Thanks for the PR!
Deployments, as required, will be available below:
Please create PRs in draft mode. Mark as ready to enable:
After merge, new images are deployed in: