Skip to content

Commit c349aee

Browse files
Add comprehensive Local Development Setup guide for Windows and Linux
1 parent e9de57a commit c349aee

File tree

2 files changed

+64
-294
lines changed

2 files changed

+64
-294
lines changed

documents/LocalDebuggingSetup.md

Lines changed: 0 additions & 294 deletions
This file was deleted.
Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -164,6 +164,70 @@ cd Conversation-Knowledge-Mining-Solution-Accelerator
164164

165165
---
166166

167+
### Configure Git (Required for Commits)
168+
169+
Before making any commits or pushes, configure your Git identity:
170+
171+
```bash
172+
# Set your name (this will appear in commit history)
173+
git config --global user.name "Your Name"
174+
175+
# Set your email (this will appear in commit history)
176+
git config --global user.email "[email protected]"
177+
178+
# Verify your configuration
179+
git config --global --list
180+
181+
# Optional: Set default branch name to 'main'
182+
git config --global init.defaultBranch main
183+
184+
# Optional: Configure line ending handling
185+
# Windows users:
186+
git config --global core.autocrlf true
187+
188+
# Linux/macOS users:
189+
git config --global core.autocrlf input
190+
```
191+
192+
> **Note**: Use your actual name and email address. If you're contributing to the repository, use the email associated with your GitHub account.
193+
194+
#### Additional Git Configuration (Optional)
195+
196+
```bash
197+
# Set default editor for commit messages
198+
git config --global core.editor "code --wait" # For VS Code
199+
# or
200+
git config --global core.editor "vim" # For Vim
201+
202+
# Enable colored output
203+
git config --global color.ui auto
204+
205+
# Set default pull behavior (recommended)
206+
git config --global pull.rebase false # merge (default)
207+
# or
208+
git config --global pull.rebase true # rebase
209+
210+
# Cache credentials (Windows)
211+
git config --global credential.helper wincred
212+
213+
# Cache credentials (Linux/macOS - cache for 1 hour)
214+
git config --global credential.helper cache
215+
git config --global credential.helper 'cache --timeout=3600'
216+
```
217+
218+
#### Verify Git Configuration
219+
220+
```bash
221+
# View all global Git settings
222+
git config --global --list
223+
224+
# View specific settings
225+
git config user.name
226+
git config user.email
227+
```
228+
229+
---
230+
167231
## Step 2: Development Tools Setup
168232

169233
### Visual Studio Code (Recommended)

0 commit comments

Comments
 (0)