-
Notifications
You must be signed in to change notification settings - Fork 26
Extend copilot-instructions #651
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
Extend copilot-instructions #651
Conversation
|
Thank you, @nirav-raval ! We will review it soon. |
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 extends the .github/copilot-instructions.md file to provide clearer operational rules for GitHub Copilot Agent, including branching conventions, dependency management restrictions, and testing requirements. The changes aim to enforce the dev branch workflow, prevent unauthorized dependency additions, and ensure Copilot Agent consults contributing.md for workflow guidance.
Key changes:
- Added "Contribution & Branching Rules" section enforcing dev branch as source and PR target
- Added dependency management restrictions preventing unauthorized npm package additions
- Added "Testing & Validation" and "Security and privacy" sections with operational guidelines
Issues identified:
- Filename references use incorrect casing (
contribution.mdinstead ofcontributing.md,CONTRIBUTING.mdinstead ofcontributing.md) - Tool names were incorrectly changed from correct
add_spo_listpattern to incorrectspo_list_addpattern - Dependency management rules are placed within "Extension Dependencies" subsection, mixing listing with rules
|
Hi @nirav-raval, could you please address the issues identified in the Copilot review before we test the flow? Also, 'Contribution & Branching Rules' section seems to be out of place. Could you add a new main section (right after 'Architecture Overview') called 'Key Considerations' and consolidate all of the do's and don'ts under it? including all your changes in - Contribution & Branching Rules, Extension Dependencies, File Changes & Documentation, Testing, and Security and privacy |
Update .github/copilot-instructions.md Co-authored-by: Copilot <[email protected]> Update .github/copilot-instructions.md Co-authored-by: Copilot <[email protected]> Update .github/copilot-instructions.md Co-authored-by: Copilot <[email protected]> Update .github/copilot-instructions.md Co-authored-by: Copilot <[email protected]> Repositioned content under separate section
c595407 to
c0f289a
Compare
Saurabh7019
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.
I modified some of the instructions so they apply correctly to the GitHub Copilot autonomous agent. Removed items that were targeted at human contributors, like, anything referring to 'running locally', 'manual testing', or 'consult a maintainer' without a clear alternative (e.g., creating a draft PR or adding a note).
Also, for future PRs, let's keep the number of commits limited.. ideally one per PR, two at most if review changes are needed. I have cleaned this PR already, just noting it for future runs.
🎯 Aim
Improve
copilot-instructions.mdto give GitHub Copilot Agent clearer operational rules regarding branching, PR targets, dependency restrictions, and required use ofcontributing.md.📷 Result
N/A
✅ What was done
devbranch as source and PR targetcontributing.mdnpm-shrinkwrap.jsonunless explicitly required🔗 Related issue
Closes: #564