Skip to content

Commit d21fd18

Browse files
committed
feat: Add comprehensive Git workflow guide for ClickIt development and release processes
1 parent cc2a5e7 commit d21fd18

File tree

3 files changed

+484
-6
lines changed

3 files changed

+484
-6
lines changed

README.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -150,10 +150,49 @@ swift build -c release
150150
swift test -c release
151151
```
152152

153+
## Documentation
154+
155+
### 📋 **Complete Development Workflow**
156+
- **[Git Workflow Guide](docs/git-workflow-guide.md)** - Complete step-by-step git workflow from feature development to production release
157+
- **[Fastlane Guide](docs/fastlane-guide.md)** - Automated build and release system documentation
158+
159+
### 🚀 **Quick Reference**
160+
161+
#### **Daily Development**
162+
```bash
163+
# 1. Start new feature
164+
git checkout main && git pull && git checkout -b feature/my-feature
165+
166+
# 2. Develop and test
167+
fastlane dev # Build and launch for testing
168+
169+
# 3. Merge to staging for beta testing
170+
git checkout staging && git merge feature/my-feature
171+
172+
# 4. Create beta release
173+
fastlane auto_beta
174+
```
175+
176+
#### **Production Release**
177+
```bash
178+
# 1. Promote staging to main
179+
git checkout main && git merge staging
180+
181+
# 2. Automated release with version bumping
182+
fastlane bump_and_release bump:minor # 1.0.0 → 1.1.0
183+
```
184+
185+
### 📚 **Additional Documentation**
186+
- **[CLAUDE.md](CLAUDE.md)** - Development guidance and project overview
187+
- **[BUILD_AND_DEPLOY.md](BUILD_AND_DEPLOY.md)** - Manual build and deployment instructions
188+
- **[CERTIFICATE_SETUP.md](CERTIFICATE_SETUP.md)** - Code signing certificate setup
189+
153190
## Contributing
154191

155192
Contributions are welcome! Please read our contributing guidelines and check the Issues tab for open tasks.
156193

194+
**Before contributing**: Read the [Git Workflow Guide](docs/git-workflow-guide.md) to understand our branch strategy and release process.
195+
157196
## License
158197

159198
MIT License - see LICENSE file for details

docs/fastlane-guide.md

Lines changed: 17 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,13 @@ This guide explains how to use Fastlane for automating ClickIt development and r
1111
- [Troubleshooting](#troubleshooting)
1212
- [Advanced Usage](#advanced-usage)
1313

14+
## 📋 Prerequisites
15+
16+
**Git Workflow Knowledge Required**: This guide assumes you understand the ClickIt git workflow. If you're unsure about branch management, merging features to staging, or the complete development process, please read **[git-workflow-guide.md](git-workflow-guide.md)** first.
17+
18+
**Quick Summary**:
19+
- Features → `staging` branch → beta release → `main` branch → production release
20+
1421
## Installation
1522

1623
### Prerequisites
@@ -281,11 +288,12 @@ fastlane bump_and_release bump:minor force:true
281288

282289
#### Zero-Friction Beta Release
283290
```bash
284-
# Switch to staging branch
291+
# After merging your feature to staging:
285292
git checkout staging
293+
git pull origin staging
286294

287-
# Make sure everything is committed
288-
git add . && git commit -m "Ready for beta"
295+
# Ensure clean working directory
296+
git status # Should show "working tree clean"
289297

290298
# One command beta release with auto-tagging
291299
fastlane auto_beta
@@ -294,11 +302,14 @@ fastlane auto_beta
294302

295303
#### Zero-Friction Production Release
296304
```bash
297-
# Switch to main branch
305+
# After merging staging to main:
298306
git checkout main
307+
git pull origin main
308+
git merge staging
309+
git push origin main
299310

300-
# Make sure everything is committed
301-
git add . && git commit -m "Ready for production"
311+
# Ensure clean working directory
312+
git status # Should show "working tree clean"
302313

303314
# One command production release with auto-tagging
304315
fastlane auto_prod version:1.2.0

0 commit comments

Comments
 (0)