-
-
Notifications
You must be signed in to change notification settings - Fork 1.2k
Add comprehensive GitHub Copilot instructions for pylint development with mandatory pre-commit #10522
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
Co-authored-by: Pierre-Sassoulas <[email protected]>
Co-authored-by: Pierre-Sassoulas <[email protected]>
@copilot regenerate the instructions from the contributor guide in |
…elated changes Co-authored-by: Pierre-Sassoulas <[email protected]>
I've regenerated the copilot instructions from the comprehensive contributor guide content in
All unrelated file modifications have been removed. Commit: 8cc79d5 |
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.
Let's remove later if this is bad, let's make it more accurate later if this is somewhat working. I don't want to invest time in reviewing this and making it actually accurate all the time and optimized.
(Not asking for an actual review of the content, just the principle of using copilot) |
Fine to us according to me! |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #10522 +/- ##
=======================================
Coverage 95.84% 95.84%
=======================================
Files 177 177
Lines 19284 19284
=======================================
Hits 18483 18483
Misses 801 801 🚀 New features to boost your workflow:
|
@copilot you should only create regression tests and not try to fix the issue if it's labelled with something that contains the word "astroid" in it. |
Understood. For issues labeled with "astroid", I will only create regression tests and not attempt to fix the issue itself. |
The other MR (#10520) is somewhat interesting. There was an astroid building error and copilot created a regression test and mocked astroid to "fix" the issue. |
@copilot in |
Add instructions to check GitHub issue labels and only create regression tests for astroid-related issues that cannot be fixed from this repository. Co-authored-by: Pierre-Sassoulas <[email protected]>
Added the issue label guidelines section to |
@copilot you should always run |
Updated |
This PR adds a comprehensive
.github/copilot-instructions.md
file that provides GitHub Copilot coding agents with detailed instructions for working effectively in the pylint codebase, with specific emphasis on mandatory pre-commit usage for AI agents.Key Features
Fully Validated Commands: Every command has been manually tested and verified, including development setup, testing procedures, and validation scenarios with specific timing expectations.
Mandatory Pre-commit for AI: Clear distinction that while pre-commit is optional for human developers, it is mandatory for AI agents to ensure code quality and consistency. The instructions emphasize:
pre-commit install
after setuppre-commit run --all-files
before any commitIssue Label Guidelines: Instructions to check GitHub issue labels and only create regression tests for astroid-related issues ("Astroid", "Needs astroid update", "Needs astroid constraint", "Needs astroid Brain 🧠") since astroid cannot be modified from this repository.
Critical Timing Information: Explicit "NEVER CANCEL" warnings with timeout recommendations:
Comprehensive Structure Guide: Clear codebase overview including key directories, important files, testing guidelines, and validation scenarios to verify changes work correctly.
The instructions start with a directive to follow them first and only fallback to additional search when incomplete, ensuring AI agents have reliable, tested workflows for pylint development.
Fixes #10521.
💡 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.