60 lines
1.3 KiB
Plaintext
60 lines
1.3 KiB
Plaintext
# Git Configuration for ProxmoxVED Development
|
|
|
|
## Recommended Git Configuration
|
|
|
|
### Set up remotes for easy syncing with upstream:
|
|
|
|
```bash
|
|
# View your current remotes
|
|
git remote -v
|
|
|
|
# If you don't have 'upstream' configured, add it:
|
|
git remote add upstream https://github.com/community-scripts/ProxmoxVED.git
|
|
|
|
# Verify both remotes exist:
|
|
git remote -v
|
|
# Should show:
|
|
# origin https://github.com/YOUR_USERNAME/ProxmoxVED.git (fetch)
|
|
# origin https://github.com/YOUR_USERNAME/ProxmoxVED.git (push)
|
|
# upstream https://github.com/community-scripts/ProxmoxVED.git (fetch)
|
|
# upstream https://github.com/community-scripts/ProxmoxVED.git (push)
|
|
```
|
|
|
|
### Configure Git User (if not done globally)
|
|
|
|
```bash
|
|
git config user.name "Your Name"
|
|
git config user.email "your.email@example.com"
|
|
|
|
# Or configure globally:
|
|
git config --global user.name "Your Name"
|
|
git config --global user.email "your.email@example.com"
|
|
```
|
|
|
|
### Useful Git Workflows
|
|
|
|
**Keep your fork up-to-date:**
|
|
```bash
|
|
git fetch upstream
|
|
git rebase upstream/main
|
|
git push origin main
|
|
```
|
|
|
|
**Create feature branch:**
|
|
```bash
|
|
git checkout -b feature/my-awesome-app
|
|
# Make changes...
|
|
git commit -m "feat: add my awesome app"
|
|
git push origin feature/my-awesome-app
|
|
```
|
|
|
|
**Pull latest from upstream:**
|
|
```bash
|
|
git fetch upstream
|
|
git merge upstream/main
|
|
```
|
|
|
|
---
|
|
|
|
For more help, see: docs/CONTRIBUTION_GUIDE.md
|