-
Notifications
You must be signed in to change notification settings - Fork 2.7k
[v5] Create copilot-instructions.md for MSAL.js #8160
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
Add comprehensive instructions for using GitHub Copilot with the MSAL.js repository, including build, testing, and validation guidelines.
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 adds comprehensive GitHub Copilot instructions to guide AI-assisted development and PR reviews in the MSAL.js repository. The documentation provides detailed guidance on building, testing, validating, and reviewing code within this monorepo.
Key Changes:
- Added
.github/copilot-instructions.mdwith build, testing, and validation workflows - Included telemetry and performance monitoring guidelines
- Documented PR review checklist and code suggestion best practices
Added restrictions on instance aware flow usage and suggestions for alternatives.
Consolidate imports and update instructions for performance events.
| ### High-Level Repository Information | ||
|
|
||
| - **Type**: Monorepo with multiple npm packages using npm workspaces | ||
| - **Size**: Large repository with 140+ package.json files across packages and samples |
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.
How is this useful for copilot? Just curious.
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.
You're right, probably not useful. A lot of this was actually generated by Copilot and will likely need some refinement as it gets more use.
Add comprehensive instructions for using GitHub Copilot with the MSAL.js repository, including build, testing, and validation guidelines.