- Notifications
You must be signed in to change notification settings - Fork27
DOC: Add comprehensive .github/copilot-instructions.md for coding agent onboarding#247
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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Draft
Copilot wants to merge2 commits intomainChoose a base branch
base:main
Could not load branches
Branch not found:{{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline, and old review comments may become outdated.
Uh oh!
There was an error while loading.Please reload this page.
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 <8655500+bewithgaurav@users.noreply.github.com>
CopilotAI changed the title[WIP] Your task is to "onboard" this repository to Copilot coding agent by adding a .github/copilot-instructions.md file in the repository that contains information describing how a coding agent seeing it for the first time can work most efficiently.You wi...DOC: Add comprehensive .github/copilot-instructions.md for coding agent onboardingSep 19, 2025
Copilot stopped work on behalf ofbewithgaurav due to an errorSeptember 19, 2025 14:14
Sign up for freeto join this conversation on GitHub. Already have an account?Sign in to comment
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.
Uh oh!
There was an error while loading.Please reload this page.
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 moreCopilot coding agent tips in the docs.