ReachableCEO
44cdd6eb67
- Move all docs to docs/ directory for clean repo structure - Create LLM-optimized versions (*-LLM.MD) for AI tool consumption - Update cross-references and links for new paths - Maintain both human-readable and machine-optimized versions - Complete documentation system with worklog tracking
2.6 KiB
2.6 KiB
AI Agent Workflow Reference
PRIMARY REFERENCE FOR: Gemini-CLI, Claude, OpenCode, and all AI tools
🚨 CRITICAL RULES
- NEVER work on
mainbranch - Always use feature branches - NEVER auto-delete feature branches - Preserve all branches permanently
- ALWAYS push before switching branches - Never lose work
- Push every 10 commits max - Keep work backed up
- Tag milestones - Mark completed stages/milestones
- UPDATE WORKLOGS - Maintain WORKLOG.md and CURRENTWORK.md
📋 Quick Commands
Start new feature:
git checkout main && git pull origin main
git checkout -b feature/your-feature-name
Before switching branches:
git add . && git commit -m "Your message"
git push origin current-branch-name
Tag a milestone:
git tag -a milestone-name -m "Description of what was completed"
git push origin milestone-name
🌳 Branch Structure
main- Stable, protected, no direct workLLMBOOTSTRAP- Initial setup/bootstrap workINTEGRATION-WIP- Auto-merge target for testingRELEASE- Manual PR target for productionfeature/*- All development work happens here
⚡ Workflow Pattern
- Create feature branch from
main - Work with frequent commits (small, logical)
- Push every ~10 commits or before branch switching
- Feature auto-merges to
INTEGRATION-WIPfor testing - Manual PR to
RELEASEwhen ready for production - NEVER delete branches - Keep for history
🏷️ Tagging Guidelines
When to tag:
- Milestone completed
- Stage finished
- Major feature done
Tag formats:
bootstrap-complete(stage names)milestone-2025-09-05(date-based)auth-module-done(feature-based)
Always use: git tag -a tagname -m "description"
🛠️ Repository Context
- Platform: Gitea (not GitHub)
- Workflow: Feature branches → Integration → Release
- Philosophy: Preserve history, frequent commits, milestone tracking
📝 Work Tracking
ALWAYS maintain work logs:
- WORKLOG.md - Medium fidelity: status, progress, next actions
- CURRENTWORK.md - High fidelity: detailed notes, concerns, questions
- LLM Versions: AGENT-LLM.MD, WORKLOG-LLM.md, CURRENTWORK-LLM.md
Update pattern:
- Start session → Update current status in WORKLOG.md
- During work → Add detailed notes to CURRENTWORK.md
- End session → Update completion status and next actions
📚 Detailed Reference
Full documentation: GIT_WORKFLOW.MD