Skip to content

Commit b95713e

Browse files
Add VS Code-specific fork and clone instructions with GitHub extension setup
Co-authored-by: dlevy-msft-sql <194277063+dlevy-msft-sql@users.noreply.github.com>
1 parent d9a7ef7 commit b95713e

File tree

1 file changed

+20
-1
lines changed

1 file changed

+20
-1
lines changed

BUILDGUIDE.md

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,9 @@ This guide will help you set up your environment, build the native bindings, and
2424

2525
## Getting Started
2626

27-
To contribute to this project, you'll need to fork and clone the repository:
27+
To contribute to this project, you'll need to fork and clone the repository. You can do this using either the command line or Visual Studio Code.
28+
29+
### Option 1: Command Line
2830

2931
1. **Fork the repository** on GitHub by clicking the "Fork" button on the [mssql-python repository page](https://github.com/microsoft/mssql-python).
3032
2. **Clone your fork** to your local machine:
@@ -37,6 +39,23 @@ To contribute to this project, you'll need to fork and clone the repository:
3739
git remote add upstream https://github.com/microsoft/mssql-python.git
3840
```
3941

42+
### Option 2: Visual Studio Code
43+
44+
1. **Install the GitHub extension** in VS Code:
45+
- Open VS Code
46+
- Go to the Extensions view (Ctrl+Shift+X)
47+
- Search for "GitHub Pull Requests and Issues" and install it
48+
2. **Fork and clone the repository**:
49+
- Navigate to the [mssql-python repository page](https://github.com/microsoft/mssql-python)
50+
- Click "Create new fork" to create a fork in your GitHub account
51+
- Open VS Code
52+
- Open the Command Palette (Ctrl+Shift+P)
53+
- Type "Git: Clone" and select it
54+
- Select "Clone from GitHub"
55+
- Search for and select your forked repository
56+
- Choose a local directory to clone to
57+
3. **The upstream remote will be set up automatically** when you fork through GitHub.
58+
4059
---
4160

4261
## Prerequisites

0 commit comments

Comments
 (0)