Skip to content

Commit

Permalink
docs: simplify git workflow documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
xyzhou-projects committed Jan 12, 2025
1 parent cbb58c3 commit 372619d
Showing 1 changed file with 44 additions and 0 deletions.
44 changes: 44 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,50 @@ yarn install
```bash
yarn dev
```
## 📖 Development Guide

### Git Workflow

**Branch Structure:**
```
main ← release PR ← dev ← PR ← feature/bug branches
```

**Steps:**
1. Create branch from `dev`
```bash
git checkout dev
git pull origin dev
git checkout -b feature/your-feature
```

2. Push changes & create PR to `dev`
```bash
git push origin feature/your-feature
```

3. After PR approval & merge:
- Delete feature branch
- Changes go to `main` via release PRs

### Commit Messages
Format: `[type]: message`

Types:
- `feat`: New features
- `fix`: Bug fixes
- `docs`: Documentation
- `style`: Formatting
- `refactor`: Code restructuring
- `test`: Tests
- `chore`: Maintenance

Examples:
```bash
feat: add calendar component
fix: resolve date picker bug
docs: update setup guide
```

## Our Team

Expand Down

0 comments on commit 372619d

Please sign in to comment.