📝 Add development workflow documentation

- Document Git branch strategy
- Explain main vs development branch usage
- Provide quick reference commands
- List current working features on main branch
This commit is contained in:
mindesbunister
2025-07-14 14:23:41 +02:00
parent de45349baa
commit e2e0324cb1

69
DEVELOPMENT.md Normal file
View File

@@ -0,0 +1,69 @@
# Development Branch Workflow
## 🌟 Current Status
- **Main Branch**: Stable, working dashboard with TradingView analysis
- **Development Branch**: Safe space for experimentation and new features
## 🔄 Git Workflow
### Working on Features
```bash
# Always work on development branch
git checkout development
# Create feature branches if needed
git checkout -b feature/new-feature
# Make changes, commit frequently
git add .
git commit -m "feat: description of changes"
# Merge back to development when ready
git checkout development
git merge feature/new-feature
```
### Protecting Main Branch
```bash
# To switch back to stable version anytime:
git checkout main
# To bring stable features from development to main:
git checkout main
git merge development # Only when development is stable
git push origin main
```
## ✅ What's Working (Main Branch)
- Homepage with hero section and status cards
- Navigation menu with Trading Bot branding
- AI Analysis page with real TradingView integration
- Screenshot capture from AI and DIY layouts
- Enhanced screenshot API with AI analysis
- All navigation pages (Analysis, Trading, Automation, Settings)
- Docker Compose v2 compatibility
- Image serving API for screenshots
## 🚧 Safe to Break (Development Branch)
- Experiment with new features
- Test breaking changes
- Try different approaches
- Refactor code structure
## 🔧 Quick Commands
```bash
# Check current branch
git branch
# See changes
git status
# Quick commit
git add . && git commit -m "description"
# Switch to stable main
git checkout main
# Back to development
git checkout development
```