-
Notifications
You must be signed in to change notification settings - Fork 27
DOC: Add comprehensive BUILDGUIDE.md with cross-platform build instructions and VS Code setup #156
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
...ment instructions Co-authored-by: bewithgaurav <8655500+bewithgaurav@users.noreply.github.com>
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 build and development documentation for the mssql-python project. The new BUILDGUIDE.md provides structured instructions for contributors to set up their development environment, build native bindings, and create Python wheel packages across Windows, macOS, and Linux platforms.
- Adds detailed cross-platform setup instructions with platform-specific requirements
- Provides clear steps for building native pybind11 bindings using existing build scripts
- Includes instructions for creating Python wheels and running tests with proper environment configuration
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.
We need to fix the broken links before this goes out. The other things seem like nice to haves.
Co-authored-by: dlevy-msft-sql <194277063+dlevy-msft-sql@users.noreply.github.com>
We need to fix the broken links before this goes out. The other things seem like nice to haves.
Fixed the broken links in commit d9a7ef7. The main issue was the incorrect path to pybind/README.md which has been corrected to mssql_python/pybind/README.md. All pybind directory references throughout the guide have been updated to use the correct path.
...n setup Co-authored-by: dlevy-msft-sql <194277063+dlevy-msft-sql@users.noreply.github.com>
Co-authored-by: dlevy-msft-sql <194277063+dlevy-msft-sql@users.noreply.github.com>
Adding tip on environment variables
...E.md Co-authored-by: dlevy-msft-sql <194277063+dlevy-msft-sql@users.noreply.github.com>
Uh oh!
There was an error while loading. Please reload this page.
Work Item / Issue Reference
Summary
This pull request adds a comprehensive build guide for contributors to the
mssql-pythonproject. The guide provides detailed instructions for setting up the development environment, building native bindings, packaging the project as a Python wheel, and running tests.Documentation Enhancements:
BUILDGUIDE.mdfile that includes:pybind11, andCMakeKey Fixes Applied:
pybind/tomssql_python/pybind/to match actual repository structureThe guide now provides a complete contributor onboarding experience with accurate paths, comprehensive setup options, support for both command-line and VS Code workflows, and detailed database setup instructions for all platforms.
This pull request was created and enhanced based on feedback to ensure all links work correctly, paths match the actual repository structure, includes modern development workflows using Visual Studio Code, and provides complete database setup instructions for Windows, macOS, and Linux.
💡 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.