DOC: Add comprehensive .github/copilot-instructions.md for coding agent onboarding #247
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Co-authored-by: bewithgaurav <[email protected]>
Copilot
AI
changed the title
Copilot stopped work on behalf of
bewithgaurav due to an error
September 19, 2025 14:14
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds a comprehensive
.github/copilot-instructions.mdfile to onboard coding agents to the mssql-python repository efficiently. The instructions are designed to significantly reduce the likelihood of failed PRs, build errors, and exploration time for future coding agents.What's Included
The copilot instructions provide detailed information about:
Key Benefits
Reduces PR Rejection Risk: Documents the complex multi-platform build system, required dependencies, and validation processes that agents need to understand to create working code changes.
Minimizes Build Failures: Provides exact command sequences, prerequisites, and expected failure modes (like missing ODBC headers on Linux) with clear explanations.
Accelerates Development: Eliminates the need for agents to discover repository structure, build processes, and testing requirements through trial and error.
The instructions follow the required format (under 2 pages, non-task-specific) and provide comprehensive coverage of the repository's unique characteristics, including its pybind11/CMake native extension build system, platform-specific library distribution, and sophisticated CI/CD matrix across multiple operating systems and architectures.
Future coding agents can now reference these instructions to work effectively with the repository immediately, rather than spending time exploring and potentially making incorrect assumptions about the build and test processes.
💡 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.