97 lines
1.9 KiB
Markdown
97 lines
1.9 KiB
Markdown
# Git Setup Guide
|
|
|
|
## Prerequisites
|
|
|
|
Since Git is not currently installed on this system, you'll need to install it first.
|
|
|
|
### Windows Installation
|
|
|
|
1. **Download Git for Windows**:
|
|
- Visit: https://git-scm.com/download/win
|
|
- Download the latest version for Windows
|
|
|
|
2. **Install Git**:
|
|
- Run the installer
|
|
- Use default settings (recommended)
|
|
- Add Git to PATH during installation
|
|
|
|
3. **Verify Installation**:
|
|
```bash
|
|
git --version
|
|
```
|
|
|
|
## Repository Setup
|
|
|
|
Once Git is installed, run these commands:
|
|
|
|
```bash
|
|
# Initialize Git repository
|
|
git init
|
|
|
|
# Create main branch
|
|
git checkout -b main
|
|
|
|
# Add all files
|
|
git add .
|
|
|
|
# Initial commit
|
|
git commit -m "Initial commit: Virtual Board Member AI System foundation"
|
|
|
|
# Add remote repository
|
|
git remote add origin https://gitea.pressmess.duckdns.org/admin/virtual_board_member.git
|
|
|
|
# Push to remote
|
|
git push -u origin main
|
|
```
|
|
|
|
## GitFlow Branching Strategy
|
|
|
|
This project uses GitFlow branching strategy:
|
|
|
|
```bash
|
|
# Create develop branch
|
|
git checkout -b develop
|
|
git push -u origin develop
|
|
|
|
# For new features
|
|
git checkout -b feature/feature-name
|
|
|
|
# For hotfixes
|
|
git checkout -b hotfix/hotfix-name
|
|
|
|
# For releases
|
|
git checkout -b release/version-number
|
|
```
|
|
|
|
## Pre-commit Hooks
|
|
|
|
After setting up Git, install pre-commit hooks:
|
|
|
|
```bash
|
|
# Install pre-commit hooks
|
|
pre-commit install
|
|
|
|
# Run manually if needed
|
|
pre-commit run --all-files
|
|
```
|
|
|
|
## CI/CD Pipeline
|
|
|
|
The GitHub Actions workflow (`.github/workflows/ci.yml`) will automatically:
|
|
- Run tests on push/PR
|
|
- Check code quality
|
|
- Perform security scanning
|
|
- Build Docker images (on main branch)
|
|
|
|
## Next Steps
|
|
|
|
1. Install Git for Windows
|
|
2. Run the repository setup commands above
|
|
3. Configure your Git identity:
|
|
```bash
|
|
git config --global user.name "Your Name"
|
|
git config --global user.email "your.email@example.com"
|
|
```
|
|
4. Install pre-commit hooks
|
|
5. Start development on feature branches
|