Compare commits
3 Commits
main
...
template-r
Author | SHA1 | Date | |
---|---|---|---|
711bcf20a1 | |||
44cdd6eb67 | |||
57685f333b |
284
CONTRIBUTING.md
284
CONTRIBUTING.md
@@ -1,284 +0,0 @@
|
|||||||
# Contributing to CTO AI Delegation Framework
|
|
||||||
|
|
||||||
**Welcome to the CTO AI Delegation Framework development!** This guide is for developers who want to contribute to the framework itself, not for users of the template.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## 🎯 **Quick Start for Contributors**
|
|
||||||
|
|
||||||
### Development Setup
|
|
||||||
```bash
|
|
||||||
# Clone the repository
|
|
||||||
git clone git@git.knownelement.com:UKRRS/CTO.git
|
|
||||||
cd CTO
|
|
||||||
|
|
||||||
# Switch to main development branch
|
|
||||||
git checkout WORKONMAIN
|
|
||||||
|
|
||||||
# Explore the full framework
|
|
||||||
ls docs/
|
|
||||||
```
|
|
||||||
|
|
||||||
### Understanding the Repository Structure
|
|
||||||
|
|
||||||
| Branch | Purpose | When to Use |
|
|
||||||
|--------|---------|-------------|
|
|
||||||
| **`main`** | Clean template baseline for end users | Never (except for README/LICENSE updates) |
|
|
||||||
| **`WORKONMAIN`** | Main development branch | Most framework development |
|
|
||||||
| **`LLMBOOTSTRAP`** | Feature development branch | Experimental features |
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## 🛠️ **Development Workflow**
|
|
||||||
|
|
||||||
### For Framework Improvements
|
|
||||||
```bash
|
|
||||||
# Start from WORKONMAIN
|
|
||||||
git checkout WORKONMAIN
|
|
||||||
git pull origin WORKONMAIN
|
|
||||||
|
|
||||||
# Create feature branch for your improvement
|
|
||||||
git checkout -b feature/your-improvement
|
|
||||||
|
|
||||||
# Make changes, test, commit
|
|
||||||
git add .
|
|
||||||
git commit -m "Add your improvement"
|
|
||||||
git push origin feature/your-improvement
|
|
||||||
|
|
||||||
# Create pull request to WORKONMAIN
|
|
||||||
```
|
|
||||||
|
|
||||||
### For Main Branch Updates (Rare)
|
|
||||||
```bash
|
|
||||||
# Only for README, LICENSE, or critical template baseline changes
|
|
||||||
git checkout WORKONMAIN # Start from full development context
|
|
||||||
|
|
||||||
# Create WORKONMAIN → main PR when approved by maintainer
|
|
||||||
# (This bypasses normal "human-only main" rule for framework development)
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## 📋 **Development Guidelines**
|
|
||||||
|
|
||||||
### Code Standards
|
|
||||||
- **Scripts must be executable:** `chmod +x script.sh`
|
|
||||||
- **Gitea-exclusive platform:** No GitHub/GitLab references
|
|
||||||
- **Git-native solutions preferred:** Avoid external dependencies
|
|
||||||
- **Dual documentation:** Maintain both human and LLM-optimized versions
|
|
||||||
|
|
||||||
### Documentation Standards
|
|
||||||
- **Update both versions:** `docs/FILE.md` and `docs/FILE-LLM.md`
|
|
||||||
- **Test all links:** Ensure Gitea web interface compatibility
|
|
||||||
- **Keep deterministic:** AI instructions must be exact command sequences
|
|
||||||
- **Platform consistency:** All references must be Gitea-specific
|
|
||||||
|
|
||||||
### Testing Requirements
|
|
||||||
```bash
|
|
||||||
# Test your changes
|
|
||||||
./test-bootstrap.sh
|
|
||||||
|
|
||||||
# Test integration automation
|
|
||||||
./setup-git-auto-merge.sh
|
|
||||||
|
|
||||||
# Generate progress dashboard
|
|
||||||
./generate-progress-dashboard.sh
|
|
||||||
|
|
||||||
# Validate all scripts work
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## 🧪 **Testing Framework**
|
|
||||||
|
|
||||||
### Bootstrap Testing
|
|
||||||
```bash
|
|
||||||
# Run comprehensive bootstrap validation
|
|
||||||
./test-bootstrap.sh
|
|
||||||
|
|
||||||
# Expected: 8 tests passing
|
|
||||||
# - Template file presence
|
|
||||||
# - Git initialization
|
|
||||||
# - Branch creation
|
|
||||||
# - Template placeholders
|
|
||||||
# - AI agent instructions
|
|
||||||
# - Milestone tagging
|
|
||||||
# - Automation script validation
|
|
||||||
# - Integration setup
|
|
||||||
```
|
|
||||||
|
|
||||||
### Integration Testing
|
|
||||||
```bash
|
|
||||||
# Test git-native auto-merge
|
|
||||||
./setup-git-auto-merge.sh
|
|
||||||
|
|
||||||
# Create test commits on feature branches
|
|
||||||
# Verify INTEGRATION-WIP auto-merge works
|
|
||||||
```
|
|
||||||
|
|
||||||
### Dashboard Testing
|
|
||||||
```bash
|
|
||||||
# Generate dashboard with current data
|
|
||||||
./generate-progress-dashboard.sh
|
|
||||||
|
|
||||||
# Check generated files
|
|
||||||
ls docs/dashboard/
|
|
||||||
open docs/dashboard/index.html
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## 📚 **Documentation Maintenance**
|
|
||||||
|
|
||||||
### Key Files to Update
|
|
||||||
When making changes, consider updating:
|
|
||||||
|
|
||||||
**Core Documentation:**
|
|
||||||
- `docs/AGENT-LLM.MD` - Primary AI agent instructions
|
|
||||||
- `docs/GIT_WORKFLOW.MD` - Comprehensive workflow guide
|
|
||||||
- `docs/INTEGRATION-AUTOMATION.md` - Integration setup guide
|
|
||||||
|
|
||||||
**Tracking Files:**
|
|
||||||
- `TODO.md` + `TODO-LLM.md` - Project roadmap
|
|
||||||
- `RETROSPECTIVE.md` + `RETROSPECTIVE-LLM.md` - Project analysis
|
|
||||||
- `PLATFORM-REQUIREMENTS.md` - Platform constraints
|
|
||||||
|
|
||||||
**Template Files:**
|
|
||||||
- `docs/WORKLOG-LLM.md` - Template progress tracking
|
|
||||||
- `docs/CURRENTWORK-LLM.md` - Template session logging
|
|
||||||
|
|
||||||
### Documentation Sync
|
|
||||||
```bash
|
|
||||||
# After updating human-readable docs, update LLM versions
|
|
||||||
# Example: Update AGENT.MD → also update AGENT-LLM.MD
|
|
||||||
|
|
||||||
# Keep content aligned but optimize format for target audience
|
|
||||||
# Human: Comprehensive, contextual, explanatory
|
|
||||||
# LLM: Concise, command-focused, deterministic
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## 🏷️ **Release Process**
|
|
||||||
|
|
||||||
### Creating Releases
|
|
||||||
```bash
|
|
||||||
# When ready to release improvements
|
|
||||||
git checkout WORKONMAIN
|
|
||||||
|
|
||||||
# Create milestone tag
|
|
||||||
git tag -a framework-v1.x.x -m "Framework improvements: [describe changes]"
|
|
||||||
git push origin framework-v1.x.x
|
|
||||||
|
|
||||||
# Maintainer creates GitHub/Gitea release from tag
|
|
||||||
# Users download release artifacts as templates
|
|
||||||
```
|
|
||||||
|
|
||||||
### Tag Naming Convention
|
|
||||||
- `framework-v1.x.x` - Framework improvements
|
|
||||||
- `phase-N-complete` - Major phase completions
|
|
||||||
- `milestone-YYYY-MM-DD` - Date-based milestones
|
|
||||||
- `feature-NAME-complete` - Specific feature completions
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## 🔍 **Code Review Guidelines**
|
|
||||||
|
|
||||||
### What Reviewers Look For
|
|
||||||
1. **Gitea Compatibility** - Works exclusively with Gitea
|
|
||||||
2. **Git-Native Solutions** - Prefers git over external tools
|
|
||||||
3. **Deterministic Instructions** - AI agents get exact commands
|
|
||||||
4. **Documentation Completeness** - Both human and LLM versions updated
|
|
||||||
5. **Testing Coverage** - Changes include appropriate tests
|
|
||||||
|
|
||||||
### Pull Request Template
|
|
||||||
```markdown
|
|
||||||
## Changes Made
|
|
||||||
- [Brief description of changes]
|
|
||||||
|
|
||||||
## Testing Done
|
|
||||||
- [ ] Bootstrap testing passes (`./test-bootstrap.sh`)
|
|
||||||
- [ ] Integration testing works (`./setup-git-auto-merge.sh`)
|
|
||||||
- [ ] Documentation updated (both human and LLM versions)
|
|
||||||
- [ ] Scripts are executable and work in clean environment
|
|
||||||
|
|
||||||
## Breaking Changes
|
|
||||||
- [Any breaking changes for template users]
|
|
||||||
|
|
||||||
## Documentation Updates
|
|
||||||
- [ ] Updated relevant docs in `docs/` directory
|
|
||||||
- [ ] Updated TODO.md if roadmap changed
|
|
||||||
- [ ] Updated RETROSPECTIVE.md if architecture changed
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## 🚨 **Important Constraints**
|
|
||||||
|
|
||||||
### Platform Requirements
|
|
||||||
- **Gitea Exclusive:** No GitHub or GitLab references anywhere
|
|
||||||
- **Git-Native Preferred:** Avoid workflow-based solutions when git hooks work
|
|
||||||
- **No External Dependencies:** Framework should work with just git + bash
|
|
||||||
|
|
||||||
### Branch Protection Rules
|
|
||||||
- **Main Branch:** Minimal, clean baseline for template users
|
|
||||||
- **WORKONMAIN:** Where framework development happens
|
|
||||||
- **Human Oversight:** All merges to main require explicit approval
|
|
||||||
|
|
||||||
### Template User Focus
|
|
||||||
- **Don't Break Template Usage:** Changes shouldn't affect template download/usage
|
|
||||||
- **Maintain Simplicity:** Template users want simple bootstrap process
|
|
||||||
- **Preserve Determinism:** AI delegation must remain predictable
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## 💡 **Development Tips**
|
|
||||||
|
|
||||||
### Environment Setup
|
|
||||||
```bash
|
|
||||||
# Work in isolated test directories
|
|
||||||
mkdir /tmp/cto-test && cd /tmp/cto-test
|
|
||||||
|
|
||||||
# Extract current template to test changes
|
|
||||||
cp -r /path/to/CTO/* .
|
|
||||||
rm -rf .git
|
|
||||||
|
|
||||||
# Test bootstrap process in clean environment
|
|
||||||
./start-ai-delegation.sh # or manual bootstrap process
|
|
||||||
```
|
|
||||||
|
|
||||||
### Common Pitfalls
|
|
||||||
- **Broken links on main branch:** Test README links work in Gitea web UI
|
|
||||||
- **Platform references:** Scan for any GitHub/GitLab mentions
|
|
||||||
- **Missing LLM docs:** Always update both human and LLM versions
|
|
||||||
- **Non-executable scripts:** Check `chmod +x` on all shell scripts
|
|
||||||
|
|
||||||
### Debugging
|
|
||||||
```bash
|
|
||||||
# Enable debug mode for scripts
|
|
||||||
export DEBUG=1
|
|
||||||
|
|
||||||
# Run with verbose output
|
|
||||||
./test-bootstrap.sh --debug
|
|
||||||
./generate-progress-dashboard.sh --check-sources
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## 📞 **Getting Help**
|
|
||||||
|
|
||||||
### Resources
|
|
||||||
- **Current Documentation:** Browse `docs/` directory on WORKONMAIN branch
|
|
||||||
- **Project Roadmap:** See `TODO.md` and `TODO-LLM.md`
|
|
||||||
- **Architecture Decisions:** Review `RETROSPECTIVE.md`
|
|
||||||
|
|
||||||
### Communication
|
|
||||||
- **Issues:** Use repository issue tracker
|
|
||||||
- **Discussions:** Repository discussions or maintainer contact
|
|
||||||
- **Pull Requests:** Follow PR template and guidelines above
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
**Thank you for contributing to the CTO AI Delegation Framework!**
|
|
||||||
|
|
||||||
*Your improvements help founder CTOs delegate more effectively to AI teams.*
|
|
104
README.md
104
README.md
@@ -1,103 +1,3 @@
|
|||||||
# CTO AI Delegation Framework
|
# CTO
|
||||||
|
|
||||||
**Prompts and code for founder CTOs who want to delegate to AI as an entire team.**
|
Prompts and code for founder CTO who want to delegate to AI as an entire team.
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## 🎯 **For CTO Template Users (Most Users)**
|
|
||||||
|
|
||||||
**If you want to use this CTO AI delegation template for your project:**
|
|
||||||
|
|
||||||
### ⚠️ **Don't Clone This Repository!**
|
|
||||||
|
|
||||||
Instead, download the latest release as a template:
|
|
||||||
|
|
||||||
1. **Download Latest Release:** [📦 Latest Release](../../releases/latest)
|
|
||||||
2. **Extract** the downloaded zip to your project directory
|
|
||||||
3. **Run Setup:** `./start-ai-delegation.sh` (or follow instructions in extracted files)
|
|
||||||
4. **Start Delegating:** AI agents will read the included documentation automatically
|
|
||||||
|
|
||||||
### 🚀 **Quick Start for Template Users**
|
|
||||||
```bash
|
|
||||||
# After extracting the release:
|
|
||||||
cd your-project-directory
|
|
||||||
./start-ai-delegation.sh
|
|
||||||
# Follow the prompts to set up your CTO AI delegation workflow
|
|
||||||
```
|
|
||||||
|
|
||||||
**What You Get:**
|
|
||||||
- ✅ Complete AI delegation framework
|
|
||||||
- ✅ Deterministic workflows for AI agents
|
|
||||||
- ✅ Professional git workflow with branch protection
|
|
||||||
- ✅ Real-time progress tracking and dashboards
|
|
||||||
- ✅ Comprehensive documentation (human + AI optimized)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## 🛠️ **For Framework Developers (Repository Contributors)**
|
|
||||||
|
|
||||||
**If you want to contribute to the CTO delegation framework itself:**
|
|
||||||
|
|
||||||
### Development Setup
|
|
||||||
```bash
|
|
||||||
# Clone the repository for development
|
|
||||||
git clone git@git.knownelement.com:UKRRS/CTO.git
|
|
||||||
cd CTO
|
|
||||||
|
|
||||||
# Switch to development branch (has all the features)
|
|
||||||
git checkout WORKONMAIN
|
|
||||||
|
|
||||||
# See full documentation and development environment
|
|
||||||
ls docs/
|
|
||||||
```
|
|
||||||
|
|
||||||
### Development Workflow
|
|
||||||
- **WORKONMAIN** - Long-lived development branch for framework improvements
|
|
||||||
- **LLMBOOTSTRAP** - Feature development branch
|
|
||||||
- **main** - Template baseline (minimal, clean for end users)
|
|
||||||
|
|
||||||
### Contributing Guidelines
|
|
||||||
See [CONTRIBUTING.md](./CONTRIBUTING.md) for detailed development instructions.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## 📊 **Repository Information**
|
|
||||||
|
|
||||||
### Branch Structure
|
|
||||||
| Branch | Purpose | Who Uses It |
|
|
||||||
|--------|---------|-------------|
|
|
||||||
| **`main`** | Clean template baseline | Template users browsing |
|
|
||||||
| **`WORKONMAIN`** | Framework development | Contributors |
|
|
||||||
| **`LLMBOOTSTRAP`** | Feature development | Contributors |
|
|
||||||
|
|
||||||
### Latest Releases
|
|
||||||
| Release | Date | Description |
|
|
||||||
|---------|------|-------------|
|
|
||||||
| [phase-2-enhancements-complete](../../releases/tag/phase-2-enhancements-complete) | 2025-09-05 | Full framework with testing, dashboards, git-native integration |
|
|
||||||
| [bootstrap-framework-complete](../../releases/tag/bootstrap-framework-complete) | 2025-09-05 | Core bootstrap framework |
|
|
||||||
|
|
||||||
### Platform Information
|
|
||||||
- **Git Platform:** Gitea (optimized exclusively)
|
|
||||||
- **AI Compatibility:** Claude, Gemini-CLI, OpenCode
|
|
||||||
- **Architecture:** Git-native automation, no external dependencies
|
|
||||||
- **License:** [View License](./LICENSE)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## 🤖 **Framework Features**
|
|
||||||
|
|
||||||
- **Deterministic AI Instructions** - Exact command sequences for consistent results
|
|
||||||
- **Git-Native Automation** - Auto-merge integration via git hooks
|
|
||||||
- **Progress Dashboards** - Real-time CTO oversight and metrics
|
|
||||||
- **Bootstrap Testing** - Comprehensive validation framework
|
|
||||||
- **Dual Documentation** - Human-readable + AI-optimized versions
|
|
||||||
- **Branch Protection** - Main branch human-only policy
|
|
||||||
- **Milestone Tracking** - Complete audit trail and progress markers
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
**Need Help?**
|
|
||||||
- **Template Users:** Check the documentation in your downloaded release
|
|
||||||
- **Developers:** See [CONTRIBUTING.md](./CONTRIBUTING.md) or browse the [WORKONMAIN branch](../../tree/WORKONMAIN)
|
|
||||||
|
|
||||||
*Professional AI team delegation framework - Built for founder CTOs*
|
|
100
TEMPLATE-README.md
Normal file
100
TEMPLATE-README.md
Normal file
@@ -0,0 +1,100 @@
|
|||||||
|
# CTO AI Delegation Template
|
||||||
|
|
||||||
|
**Template for founder CTOs to delegate development work to AI agents as a complete team**
|
||||||
|
|
||||||
|
## 🚀 Quick Start
|
||||||
|
|
||||||
|
**Download and setup this template:**
|
||||||
|
|
||||||
|
1. **Download the latest milestone:** Download the zip file from your chosen milestone tag
|
||||||
|
2. **Extract to your project directory:** `unzip milestone.zip`
|
||||||
|
3. **Initialize git repository:**
|
||||||
|
```bash
|
||||||
|
git init
|
||||||
|
git add .
|
||||||
|
git commit -m "Initial commit from CTO delegation template"
|
||||||
|
git branch -M main
|
||||||
|
git remote add origin YOUR_REPOSITORY_URL
|
||||||
|
git push -u origin main
|
||||||
|
```
|
||||||
|
4. **Create required branches:**
|
||||||
|
```bash
|
||||||
|
git checkout -b INTEGRATION-WIP && git push -u origin INTEGRATION-WIP
|
||||||
|
git checkout -b RELEASE && git push -u origin RELEASE
|
||||||
|
git checkout main
|
||||||
|
```
|
||||||
|
|
||||||
|
## 🤖 AI Agent Quick Start
|
||||||
|
|
||||||
|
**For immediate AI delegation, tell your AI agent:**
|
||||||
|
|
||||||
|
1. **Read the LLM-optimized instructions:** `docs/AGENT-LLM.MD`
|
||||||
|
2. **Update project info:** Fill in bracketed fields in `docs/WORKLOG-LLM.md`
|
||||||
|
3. **Start first feature:** Follow the deterministic workflow in AGENT-LLM.MD
|
||||||
|
|
||||||
|
## 📚 Documentation Structure
|
||||||
|
|
||||||
|
### For AI Agents (LLM-Optimized)
|
||||||
|
- **`docs/AGENT-LLM.MD`** - Complete AI workflow reference (READ THIS FIRST)
|
||||||
|
- **`docs/WORKLOG-LLM.md`** - Session tracking and progress
|
||||||
|
- **`docs/CURRENTWORK-LLM.md`** - Detailed notes and decisions
|
||||||
|
|
||||||
|
### For Humans (Comprehensive)
|
||||||
|
- **`docs/GIT_WORKFLOW.MD`** - Complete git workflow documentation
|
||||||
|
- **`docs/AGENT.MD`** - Human-readable AI agent guidelines
|
||||||
|
- **`docs/WORKLOG.md`** - Human-readable progress tracking
|
||||||
|
- **`docs/CURRENTWORK.md`** - Human-readable detailed session logs
|
||||||
|
|
||||||
|
## 🎯 CTO Delegation Philosophy
|
||||||
|
|
||||||
|
This template enables deterministic AI delegation by:
|
||||||
|
|
||||||
|
1. **Strict Workflow Enforcement** - AI agents follow exact command sequences
|
||||||
|
2. **Complete Audit Trail** - Every decision and change is logged
|
||||||
|
3. **Branch Preservation** - Never lose work, maintain complete history
|
||||||
|
4. **Milestone Tracking** - Clear progress markers and achievements
|
||||||
|
5. **Deterministic Outcomes** - Consistent results across AI sessions
|
||||||
|
|
||||||
|
## 🏗️ Project Structure
|
||||||
|
|
||||||
|
```
|
||||||
|
your-project/
|
||||||
|
├── README.md (replace this file with your project README)
|
||||||
|
├── docs/
|
||||||
|
│ ├── AGENT-LLM.MD (AI agent primary reference)
|
||||||
|
│ ├── WORKLOG-LLM.md (update with your project info)
|
||||||
|
│ ├── CURRENTWORK-LLM.md (session tracking)
|
||||||
|
│ └── [other documentation files]
|
||||||
|
└── [your project files]
|
||||||
|
```
|
||||||
|
|
||||||
|
## 🔧 Workflow Overview
|
||||||
|
|
||||||
|
1. **AI agents read `docs/AGENT-LLM.MD`** for complete instructions
|
||||||
|
2. **Every session updates both worklog files** with progress and decisions
|
||||||
|
3. **Features developed on dedicated branches** with descriptive names
|
||||||
|
4. **Milestones tagged** when major features/stages complete
|
||||||
|
5. **Integration testing** through INTEGRATION-WIP branch
|
||||||
|
6. **Production releases** through manual RELEASE branch PRs
|
||||||
|
|
||||||
|
## ⚙️ Customization
|
||||||
|
|
||||||
|
**After setup, customize for your project:**
|
||||||
|
|
||||||
|
1. Replace this README.md with your actual project README
|
||||||
|
2. Update bracketed fields in `docs/WORKLOG-LLM.md`
|
||||||
|
3. Modify workflow rules in `docs/AGENT-LLM.MD` if needed
|
||||||
|
4. Set up repository protection rules as described in documentation
|
||||||
|
|
||||||
|
## 📊 Template Features
|
||||||
|
|
||||||
|
- ✅ **Deterministic AI delegation** with exact command sequences
|
||||||
|
- ✅ **Complete documentation** (human + LLM optimized)
|
||||||
|
- ✅ **Audit trail maintenance** for CTO oversight
|
||||||
|
- ✅ **Professional git workflow** with branch protection
|
||||||
|
- ✅ **Milestone tracking** for progress measurement
|
||||||
|
- ✅ **Platform agnostic** (GitHub, Gitea, GitLab compatible)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
**This template provides everything needed for professional AI team delegation while maintaining CTO control and oversight.**
|
100
docs/AGENT-LLM.MD
Normal file
100
docs/AGENT-LLM.MD
Normal file
@@ -0,0 +1,100 @@
|
|||||||
|
# AI AGENT REFERENCE - TEMPLATE VERSION
|
||||||
|
|
||||||
|
**FOR: Gemini-CLI, Claude, OpenCode, all AI tools working with CTO delegation template**
|
||||||
|
|
||||||
|
## CRITICAL SETUP (FIRST TIME ONLY)
|
||||||
|
**This template requires initial git setup:**
|
||||||
|
```bash
|
||||||
|
git init
|
||||||
|
git add .
|
||||||
|
git commit -m "Initial commit from CTO template"
|
||||||
|
git branch -M main
|
||||||
|
git remote add origin YOUR_REPO_URL
|
||||||
|
git push -u origin main
|
||||||
|
```
|
||||||
|
|
||||||
|
**Create required branches:**
|
||||||
|
```bash
|
||||||
|
git checkout -b INTEGRATION-WIP && git push -u origin INTEGRATION-WIP
|
||||||
|
git checkout -b RELEASE && git push -u origin RELEASE
|
||||||
|
git checkout main
|
||||||
|
```
|
||||||
|
|
||||||
|
## CRITICAL RULES
|
||||||
|
1. NEVER work on `main` branch - Always use feature branches
|
||||||
|
2. NEVER auto-delete feature branches - Preserve all branches permanently
|
||||||
|
3. ALWAYS push before switching branches - Never lose work
|
||||||
|
4. Push every 10 commits max - Keep work backed up
|
||||||
|
5. Tag milestones - Mark completed stages/milestones
|
||||||
|
6. UPDATE WORKLOGS - Maintain both worklog files
|
||||||
|
|
||||||
|
## DETERMINISTIC COMMANDS
|
||||||
|
|
||||||
|
**Start new feature (EXACT sequence):**
|
||||||
|
```bash
|
||||||
|
git checkout main
|
||||||
|
git pull origin main
|
||||||
|
git checkout -b feature/TASK-NAME
|
||||||
|
```
|
||||||
|
|
||||||
|
**Save work before switching (MANDATORY):**
|
||||||
|
```bash
|
||||||
|
git add .
|
||||||
|
git commit -m "SPECIFIC_DESCRIPTION_OF_CHANGES"
|
||||||
|
git push origin CURRENT-BRANCH-NAME
|
||||||
|
```
|
||||||
|
|
||||||
|
**Tag completed milestone:**
|
||||||
|
```bash
|
||||||
|
git tag -a MILESTONE-NAME -m "DETAILED_DESCRIPTION_OF_COMPLETION"
|
||||||
|
git push origin MILESTONE-NAME
|
||||||
|
```
|
||||||
|
|
||||||
|
## BRANCH STRUCTURE (CREATE THESE)
|
||||||
|
- **`main`** - Stable, protected, no direct commits
|
||||||
|
- **`INTEGRATION-WIP`** - Auto-merge target for testing features
|
||||||
|
- **`RELEASE`** - Manual PR target for production releases
|
||||||
|
- **`feature/TASK-NAME`** - All development work (descriptive names)
|
||||||
|
|
||||||
|
## DETERMINISTIC WORKFLOW
|
||||||
|
1. **Always start from main:** `git checkout main && git pull origin main`
|
||||||
|
2. **Create specific branch:** `git checkout -b feature/EXACT-TASK-NAME`
|
||||||
|
3. **Work in small chunks:** Commit every logical change
|
||||||
|
4. **Push frequently:** Every 5-10 commits or before any branch switch
|
||||||
|
5. **Never delete branches:** Preserve all feature branches permanently
|
||||||
|
6. **Tag milestones:** When features/stages complete
|
||||||
|
|
||||||
|
## MILESTONE TAGGING (DETERMINISTIC)
|
||||||
|
**When to tag:**
|
||||||
|
- Feature completely implemented and tested
|
||||||
|
- Stage of project fully complete
|
||||||
|
- Major milestone achieved
|
||||||
|
|
||||||
|
**Format (be specific):**
|
||||||
|
- `feature-auth-complete` (feature done)
|
||||||
|
- `milestone-YYYY-MM-DD-DESCRIPTION` (date+description)
|
||||||
|
- `stage-NAME-done` (stage complete)
|
||||||
|
|
||||||
|
## WORKLOG MAINTENANCE (MANDATORY)
|
||||||
|
**Update these files every session:**
|
||||||
|
- **docs/WORKLOG-LLM.md** - Current status, progress, next actions
|
||||||
|
- **docs/CURRENTWORK-LLM.md** - Detailed notes, decisions, concerns
|
||||||
|
|
||||||
|
**Pattern (deterministic):**
|
||||||
|
1. Session start → Update current status in WORKLOG-LLM.md
|
||||||
|
2. During work → Add detailed notes to CURRENTWORK-LLM.md
|
||||||
|
3. Session end → Update completion status and next actions
|
||||||
|
|
||||||
|
## CTO DELEGATION PRINCIPLES
|
||||||
|
**Make outcomes deterministic:**
|
||||||
|
- Use specific commit messages describing exact changes
|
||||||
|
- Tag with descriptive names explaining what was accomplished
|
||||||
|
- Document all decisions and concerns in CURRENTWORK-LLM.md
|
||||||
|
- Follow exact command sequences above
|
||||||
|
- Never deviate from branch protection rules
|
||||||
|
|
||||||
|
## CONTEXT
|
||||||
|
- **Purpose:** Template for CTO AI delegation framework
|
||||||
|
- **Platform:** Any git hosting (GitHub, Gitea, GitLab)
|
||||||
|
- **Structure:** Keep docs in docs/ directory for clean repos
|
||||||
|
- **Philosophy:** Deterministic AI delegation with complete audit trail
|
85
docs/AGENT.MD
Normal file
85
docs/AGENT.MD
Normal file
@@ -0,0 +1,85 @@
|
|||||||
|
# AI Agent Workflow Reference
|
||||||
|
|
||||||
|
**PRIMARY REFERENCE FOR: Gemini-CLI, Claude, OpenCode, and all AI tools**
|
||||||
|
|
||||||
|
## 🚨 CRITICAL RULES
|
||||||
|
|
||||||
|
1. **NEVER work on `main` branch** - Always use feature branches
|
||||||
|
2. **NEVER auto-delete feature branches** - Preserve all branches permanently
|
||||||
|
3. **ALWAYS push before switching branches** - Never lose work
|
||||||
|
4. **Push every 10 commits max** - Keep work backed up
|
||||||
|
5. **Tag milestones** - Mark completed stages/milestones
|
||||||
|
6. **UPDATE WORKLOGS** - Maintain WORKLOG.md and CURRENTWORK.md
|
||||||
|
|
||||||
|
## 📋 Quick Commands
|
||||||
|
|
||||||
|
**Start new feature:**
|
||||||
|
```bash
|
||||||
|
git checkout main && git pull origin main
|
||||||
|
git checkout -b feature/your-feature-name
|
||||||
|
```
|
||||||
|
|
||||||
|
**Before switching branches:**
|
||||||
|
```bash
|
||||||
|
git add . && git commit -m "Your message"
|
||||||
|
git push origin current-branch-name
|
||||||
|
```
|
||||||
|
|
||||||
|
**Tag a milestone:**
|
||||||
|
```bash
|
||||||
|
git tag -a milestone-name -m "Description of what was completed"
|
||||||
|
git push origin milestone-name
|
||||||
|
```
|
||||||
|
|
||||||
|
## 🌳 Branch Structure
|
||||||
|
|
||||||
|
- **`main`** - Stable, protected, no direct work
|
||||||
|
- **`LLMBOOTSTRAP`** - Initial setup/bootstrap work
|
||||||
|
- **`INTEGRATION-WIP`** - Auto-merge target for testing
|
||||||
|
- **`RELEASE`** - Manual PR target for production
|
||||||
|
- **`feature/*`** - All development work happens here
|
||||||
|
|
||||||
|
## ⚡ Workflow Pattern
|
||||||
|
|
||||||
|
1. Create feature branch from `main`
|
||||||
|
2. Work with frequent commits (small, logical)
|
||||||
|
3. Push every ~10 commits or before branch switching
|
||||||
|
4. Feature auto-merges to `INTEGRATION-WIP` for testing
|
||||||
|
5. Manual PR to `RELEASE` when ready for production
|
||||||
|
6. **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](./WORKLOG.md)** - Medium fidelity: status, progress, next actions
|
||||||
|
- **[CURRENTWORK.md](./CURRENTWORK.md)** - High fidelity: detailed notes, concerns, questions
|
||||||
|
- **LLM Versions:** [AGENT-LLM.MD](./AGENT-LLM.MD), [WORKLOG-LLM.md](./WORKLOG-LLM.md), [CURRENTWORK-LLM.md](./CURRENTWORK-LLM.md)
|
||||||
|
|
||||||
|
**Update pattern:**
|
||||||
|
1. Start session → Update current status in WORKLOG.md
|
||||||
|
2. During work → Add detailed notes to CURRENTWORK.md
|
||||||
|
3. End session → Update completion status and next actions
|
||||||
|
|
||||||
|
## 📚 Detailed Reference
|
||||||
|
|
||||||
|
Full documentation: [GIT_WORKFLOW.MD](./GIT_WORKFLOW.MD)
|
111
docs/CURRENTWORK-LLM.md
Normal file
111
docs/CURRENTWORK-LLM.md
Normal file
@@ -0,0 +1,111 @@
|
|||||||
|
# CURRENTWORK - TEMPLATE VERSION
|
||||||
|
|
||||||
|
**SESSION:** [UPDATE_DATE] - [SESSION_DESCRIPTION]
|
||||||
|
**AGENT:** [AI_AGENT_NAME]
|
||||||
|
**BRANCH:** [CURRENT_BRANCH]
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 🎯 CURRENT FOCUS: [MAIN_OBJECTIVE]
|
||||||
|
|
||||||
|
### Objective
|
||||||
|
[DETAILED_DESCRIPTION_OF_WHAT_YOURE_BUILDING]
|
||||||
|
|
||||||
|
### Progress Notes
|
||||||
|
|
||||||
|
#### ✅ Completed in This Session
|
||||||
|
|
||||||
|
**[WORK_CATEGORY_1]**
|
||||||
|
- [SPECIFIC_COMPLETION_1]
|
||||||
|
- [SPECIFIC_COMPLETION_2]
|
||||||
|
- [SPECIFIC_COMPLETION_3]
|
||||||
|
|
||||||
|
**[WORK_CATEGORY_2]**
|
||||||
|
- [SPECIFIC_COMPLETION_4]
|
||||||
|
- [SPECIFIC_COMPLETION_5]
|
||||||
|
|
||||||
|
#### 🔄 Currently Working On
|
||||||
|
|
||||||
|
**[CURRENT_WORK_ITEM]**
|
||||||
|
- [SPECIFIC_DETAIL_1]
|
||||||
|
- [SPECIFIC_DETAIL_2]
|
||||||
|
- [CURRENT_STATUS_OR_CHALLENGE]
|
||||||
|
|
||||||
|
### Technical Decisions Made
|
||||||
|
|
||||||
|
1. **[DECISION_CATEGORY]:**
|
||||||
|
- [DECISION_DESCRIPTION]
|
||||||
|
- [RATIONALE]
|
||||||
|
- [ALTERNATIVE_CONSIDERED]
|
||||||
|
|
||||||
|
2. **[ANOTHER_DECISION_CATEGORY]:**
|
||||||
|
- [DECISION_DESCRIPTION]
|
||||||
|
- [RATIONALE]
|
||||||
|
|
||||||
|
### Concerns & Questions
|
||||||
|
|
||||||
|
#### [CONCERN_CATEGORY]
|
||||||
|
- **Concern:** [SPECIFIC_CONCERN]
|
||||||
|
- **Question:** [SPECIFIC_QUESTION]
|
||||||
|
- **Decision:** [HOW_ADDRESSED_OR_DEFERRED]
|
||||||
|
|
||||||
|
#### [ANOTHER_CONCERN_CATEGORY]
|
||||||
|
- **Concern:** [SPECIFIC_CONCERN]
|
||||||
|
- **Action:** [WHAT_NEEDS_TO_BE_DONE]
|
||||||
|
|
||||||
|
### Next Immediate Steps
|
||||||
|
|
||||||
|
1. **[NEXT_STEP_1]:**
|
||||||
|
- [SPECIFIC_ACTION]
|
||||||
|
- [EXPECTED_OUTCOME]
|
||||||
|
|
||||||
|
2. **[NEXT_STEP_2]:**
|
||||||
|
- [SPECIFIC_ACTION]
|
||||||
|
- [EXPECTED_OUTCOME]
|
||||||
|
|
||||||
|
3. **Future Sessions:**
|
||||||
|
- [PLANNED_WORK]
|
||||||
|
- [DEPENDENCIES_OR_BLOCKERS]
|
||||||
|
|
||||||
|
### Code/Configuration References
|
||||||
|
|
||||||
|
**Commands Used This Session:**
|
||||||
|
```bash
|
||||||
|
[COMMAND_1]
|
||||||
|
[COMMAND_2]
|
||||||
|
[COMMAND_3]
|
||||||
|
```
|
||||||
|
|
||||||
|
**Files Modified:**
|
||||||
|
- [FILE_1] ([DESCRIPTION_OF_CHANGES])
|
||||||
|
- [FILE_2] ([DESCRIPTION_OF_CHANGES])
|
||||||
|
|
||||||
|
**New Files Created:**
|
||||||
|
- [FILE_1] ([PURPOSE_AND_CONTENTS])
|
||||||
|
- [FILE_2] ([PURPOSE_AND_CONTENTS])
|
||||||
|
|
||||||
|
### Environment Context
|
||||||
|
- **Platform:** [OS/ENVIRONMENT]
|
||||||
|
- **Git Status:** [CLEAN/PENDING_CHANGES]
|
||||||
|
- **Current Branch:** [BRANCH_NAME]
|
||||||
|
- **Remote:** [REPOSITORY_URL]
|
||||||
|
- **Agent:** [AI_AGENT_AND_VERSION]
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 📋 CTO DELEGATION NOTES
|
||||||
|
|
||||||
|
**Deterministic Outcomes Achieved:**
|
||||||
|
- [SPECIFIC_MEASURABLE_OUTCOME_1]
|
||||||
|
- [SPECIFIC_MEASURABLE_OUTCOME_2]
|
||||||
|
|
||||||
|
**AI Decision Rationale:**
|
||||||
|
- [EXPLAIN_WHY_SPECIFIC_APPROACH_CHOSEN]
|
||||||
|
- [DOCUMENT_ALTERNATIVES_CONSIDERED]
|
||||||
|
|
||||||
|
**Handoff Information:**
|
||||||
|
- [WHAT_NEXT_AGENT_NEEDS_TO_KNOW]
|
||||||
|
- [ANY_CONTEXT_REQUIRED_FOR_CONTINUATION]
|
||||||
|
|
||||||
|
---
|
||||||
|
*Detailed log maintained by AI agents for CTO delegation transparency*
|
128
docs/CURRENTWORK.md
Normal file
128
docs/CURRENTWORK.md
Normal file
@@ -0,0 +1,128 @@
|
|||||||
|
# Current Work - Detailed Log
|
||||||
|
|
||||||
|
**Session:** 2025-09-05 Bootstrap Setup
|
||||||
|
**Agent:** Claude Code
|
||||||
|
**Branch:** LLMBOOTSTRAP
|
||||||
|
**Related:** [WORKLOG.md](./WORKLOG.md)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 🎯 Current Focus: Worklog System Implementation
|
||||||
|
|
||||||
|
### Objective
|
||||||
|
Setting up comprehensive work tracking system with:
|
||||||
|
- Medium fidelity WORKLOG.md for status/progress tracking
|
||||||
|
- High fidelity CURRENTWORK.md for detailed notes/concerns
|
||||||
|
- Proper cross-referencing between documents
|
||||||
|
|
||||||
|
### Progress Notes
|
||||||
|
|
||||||
|
#### ✅ Completed in This Session
|
||||||
|
|
||||||
|
**Branch Structure Setup**
|
||||||
|
- Created LLMBOOTSTRAP, INTEGRATION-WIP, RELEASE branches
|
||||||
|
- All branches properly created from main
|
||||||
|
- No issues with branch creation process
|
||||||
|
|
||||||
|
**Documentation Creation**
|
||||||
|
- GIT_WORKFLOW.MD: Comprehensive workflow with DO/DON'T examples
|
||||||
|
- Added explicit branch preservation rules (NEVER auto-delete)
|
||||||
|
- Included commit/push frequency guidelines (every 10 commits, before branch switches)
|
||||||
|
- Added tagging guidelines for milestones
|
||||||
|
- Total lines: ~147 lines of detailed documentation
|
||||||
|
|
||||||
|
**LLM Optimization**
|
||||||
|
- Completely rewrote AGENT.MD for AI tool consumption
|
||||||
|
- Added visual structure with emojis for quick parsing
|
||||||
|
- Created quick command reference blocks
|
||||||
|
- Structured for Gemini-CLI, Claude, OpenCode compatibility
|
||||||
|
- Reduced cognitive load while maintaining completeness
|
||||||
|
|
||||||
|
**Milestone Tracking**
|
||||||
|
- Successfully created and pushed first tag: `bootstrap-complete`
|
||||||
|
- Tag includes descriptive annotation about what was accomplished
|
||||||
|
- Demonstrates proper tagging workflow for future reference
|
||||||
|
|
||||||
|
#### 🔄 Currently Working On
|
||||||
|
|
||||||
|
**Worklog System Design**
|
||||||
|
- WORKLOG.md structure completed - medium fidelity status tracking
|
||||||
|
- CURRENTWORK.md in progress - high fidelity detailed logging
|
||||||
|
- Cross-linking between documents for easy navigation
|
||||||
|
|
||||||
|
### Technical Decisions Made
|
||||||
|
|
||||||
|
1. **Branch Naming Convention:**
|
||||||
|
- Used descriptive names (LLMBOOTSTRAP vs generic feature-1)
|
||||||
|
- INTEGRATION-WIP clearly indicates purpose
|
||||||
|
- RELEASE clearly indicates production readiness
|
||||||
|
|
||||||
|
2. **Documentation Strategy:**
|
||||||
|
- GIT_WORKFLOW.MD: Human-readable comprehensive reference
|
||||||
|
- AGENT.MD: LLM-optimized quick reference
|
||||||
|
- Dual approach ensures both human and AI accessibility
|
||||||
|
|
||||||
|
3. **Tagging Strategy:**
|
||||||
|
- Descriptive names over version numbers for clarity
|
||||||
|
- Annotated tags with meaningful descriptions
|
||||||
|
- Push immediately after creation to preserve milestones
|
||||||
|
|
||||||
|
### Concerns & Questions
|
||||||
|
|
||||||
|
#### Repository Structure
|
||||||
|
- **Concern:** Current flat structure in root directory
|
||||||
|
- **Question:** Should we organize docs into subdirectories later?
|
||||||
|
- **Decision:** Keep flat for now for simplicity, reorganize if it becomes cluttered
|
||||||
|
|
||||||
|
#### Worklog Maintenance
|
||||||
|
- **Concern:** Who maintains the worklog consistency?
|
||||||
|
- **Assumption:** Each AI agent should update both WORKLOG.md and CURRENTWORK.md
|
||||||
|
- **Need:** Clear guidelines in AGENT.MD about worklog maintenance
|
||||||
|
|
||||||
|
#### Integration Branch Usage
|
||||||
|
- **Question:** How exactly will INTEGRATION-WIP auto-merge work?
|
||||||
|
- **Status:** Documented in workflow but may need Gitea configuration
|
||||||
|
- **Action:** Future task to configure Gitea merge automation
|
||||||
|
|
||||||
|
### Next Immediate Steps
|
||||||
|
|
||||||
|
1. **Complete Worklog System:**
|
||||||
|
- Finish CURRENTWORK.md structure
|
||||||
|
- Update AGENT.MD with worklog references
|
||||||
|
- Commit and tag worklog milestone
|
||||||
|
|
||||||
|
2. **Test Workflow:**
|
||||||
|
- Verify all links work in Gitea web interface
|
||||||
|
- Ensure markdown renders properly
|
||||||
|
- Validate cross-references function
|
||||||
|
|
||||||
|
3. **Future Sessions:**
|
||||||
|
- Each new session should update both logs
|
||||||
|
- Maintain current status in WORKLOG.md
|
||||||
|
- Add detailed notes to CURRENTWORK.md
|
||||||
|
|
||||||
|
### Code/Configuration References
|
||||||
|
|
||||||
|
**Git Commands Used:**
|
||||||
|
```bash
|
||||||
|
git checkout -b LLMBOOTSTRAP
|
||||||
|
git checkout main && git checkout -b INTEGRATION-WIP
|
||||||
|
git checkout main && git checkout -b RELEASE
|
||||||
|
git tag -a bootstrap-complete -m "Initial project structure and git workflow setup completed"
|
||||||
|
git push origin bootstrap-complete
|
||||||
|
```
|
||||||
|
|
||||||
|
**Files Created This Session:**
|
||||||
|
- GIT_WORKFLOW.MD (comprehensive workflow documentation)
|
||||||
|
- AGENT.MD (LLM-optimized reference)
|
||||||
|
- WORKLOG.md (medium fidelity progress tracking)
|
||||||
|
- CURRENTWORK.md (this file - high fidelity detailed logging)
|
||||||
|
|
||||||
|
### Environment Context
|
||||||
|
- Platform: Linux 6.1.0-37-amd64
|
||||||
|
- Git repo: Clean working state on LLMBOOTSTRAP
|
||||||
|
- Remote: Gitea (ssh://git.knownelement.com:29418/UKRRS/CTO.git)
|
||||||
|
- Agent: Claude Sonnet 4 (claude-sonnet-4-20250514)
|
||||||
|
|
||||||
|
---
|
||||||
|
*Detailed log maintained by AI agents - Last updated: 2025-09-05*
|
174
docs/GIT_WORKFLOW.MD
Normal file
174
docs/GIT_WORKFLOW.MD
Normal file
@@ -0,0 +1,174 @@
|
|||||||
|
# Git Workflow
|
||||||
|
|
||||||
|
This document outlines the git workflow for this repository, designed for use with Gitea.
|
||||||
|
|
||||||
|
## Branch Structure
|
||||||
|
|
||||||
|
### Main Branches
|
||||||
|
|
||||||
|
- **`main`** - The primary stable branch. Direct work should NOT be done on this branch.
|
||||||
|
- **`RELEASE`** - Production-ready code. Only accepts pull requests that have been manually reviewed and approved.
|
||||||
|
- **`INTEGRATION-WIP`** - Integration branch where all feature branches are automatically merged for testing and integration.
|
||||||
|
|
||||||
|
### Feature Branches
|
||||||
|
|
||||||
|
- **`LLMBOOTSTRAP`** - Initial bootstrap feature branch for LLM-assisted development setup.
|
||||||
|
- Additional feature branches should follow naming conventions like `feature/description` or `task/description`.
|
||||||
|
|
||||||
|
## Workflow Rules
|
||||||
|
|
||||||
|
1. **Never work directly on `main`** - All work must be done on feature branches.
|
||||||
|
|
||||||
|
2. **Feature Development Flow:**
|
||||||
|
- Create feature branches from `main`
|
||||||
|
- Develop features in isolation on these branches
|
||||||
|
- Feature branches automatically merge to `INTEGRATION-WIP` for continuous integration testing
|
||||||
|
|
||||||
|
3. **Integration Testing:**
|
||||||
|
- `INTEGRATION-WIP` branch serves as the integration environment
|
||||||
|
- All feature branches are automatically merged here
|
||||||
|
- Used for testing compatibility between different features
|
||||||
|
|
||||||
|
4. **Release Process:**
|
||||||
|
- Only manually reviewed pull requests are merged to `RELEASE`
|
||||||
|
- `RELEASE` branch represents production-ready code
|
||||||
|
- Requires explicit approval before merging
|
||||||
|
|
||||||
|
## Branch Protection
|
||||||
|
|
||||||
|
- `main` - Protected, no direct commits allowed
|
||||||
|
- `RELEASE` - Protected, only manual PR merges allowed
|
||||||
|
- `INTEGRATION-WIP` - Accepts automatic merges from feature branches
|
||||||
|
|
||||||
|
## Feature Branch Management
|
||||||
|
|
||||||
|
### **CRITICAL: Branch Preservation**
|
||||||
|
- **NEVER automatically delete feature branches** under any circumstances
|
||||||
|
- Feature branches must be preserved for historical reference and potential future work
|
||||||
|
- Branch deletion should only occur through explicit manual action after careful consideration
|
||||||
|
|
||||||
|
### **Commit and Push Frequency**
|
||||||
|
- **Commit frequently** - Make small, logical commits as you work
|
||||||
|
- **Push every 10 commits maximum** - Don't let local commits accumulate
|
||||||
|
- **ALWAYS push before switching branches** - Ensure work is backed up remotely
|
||||||
|
- **Push immediately before any branch operations** (merge, rebase, etc.)
|
||||||
|
|
||||||
|
### **Tagging for Milestones**
|
||||||
|
- **Create tags when interim stages or milestones are completed**
|
||||||
|
- **Push tags immediately after creation** to preserve milestone markers
|
||||||
|
- **Tag naming conventions:**
|
||||||
|
- Date-based: `milestone-YYYY-MM-DD` or `stage-YYYY-MM-DD-HHMM`
|
||||||
|
- Stage-based: `bootstrap-complete`, `auth-module-done`, `integration-ready`
|
||||||
|
- Plan-based: Use milestone names from planning documents
|
||||||
|
- **Always annotate tags** with meaningful descriptions of what was accomplished
|
||||||
|
|
||||||
|
## Best Practices
|
||||||
|
|
||||||
|
- Keep feature branches focused and small
|
||||||
|
- Use descriptive branch names
|
||||||
|
- Regularly sync feature branches with `main`
|
||||||
|
- Test thoroughly in `INTEGRATION-WIP` before requesting merge to `RELEASE`
|
||||||
|
- Write clear commit messages and PR descriptions
|
||||||
|
- Follow the commit/push frequency rules above
|
||||||
|
|
||||||
|
## Examples: DO and DON'T
|
||||||
|
|
||||||
|
### ✅ **DO Examples**
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# DO: Create feature branch from main
|
||||||
|
git checkout main
|
||||||
|
git pull origin main
|
||||||
|
git checkout -b feature/user-authentication
|
||||||
|
|
||||||
|
# DO: Commit frequently with descriptive messages
|
||||||
|
git add .
|
||||||
|
git commit -m "Add user login form validation"
|
||||||
|
git commit -m "Implement password hashing utility"
|
||||||
|
git commit -m "Add user session management"
|
||||||
|
|
||||||
|
# DO: Push after every 10 commits or before switching branches
|
||||||
|
git push origin feature/user-authentication
|
||||||
|
|
||||||
|
# DO: Push before switching to another branch
|
||||||
|
git push origin feature/user-authentication
|
||||||
|
git checkout feature/payment-system
|
||||||
|
|
||||||
|
# DO: Sync feature branch with main regularly
|
||||||
|
git checkout main
|
||||||
|
git pull origin main
|
||||||
|
git checkout feature/user-authentication
|
||||||
|
git merge main
|
||||||
|
|
||||||
|
# DO: Tag milestones with descriptive annotations
|
||||||
|
git tag -a bootstrap-complete -m "Initial project structure and workflow setup completed"
|
||||||
|
git push origin bootstrap-complete
|
||||||
|
|
||||||
|
# DO: Use date-based tags for interim stages
|
||||||
|
git tag -a stage-2025-09-05-1430 -m "Authentication module implementation complete"
|
||||||
|
git push origin stage-2025-09-05-1430
|
||||||
|
```
|
||||||
|
|
||||||
|
### ❌ **DON'T Examples**
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# DON'T: Work directly on main
|
||||||
|
git checkout main
|
||||||
|
git add .
|
||||||
|
git commit -m "Fix user auth bug" # ❌ NEVER DO THIS
|
||||||
|
|
||||||
|
# DON'T: Delete feature branches automatically
|
||||||
|
git branch -d feature/user-authentication # ❌ NEVER DO THIS
|
||||||
|
git push origin --delete feature/user-authentication # ❌ NEVER DO THIS
|
||||||
|
|
||||||
|
# DON'T: Let commits accumulate without pushing
|
||||||
|
git log --oneline # Shows 15+ unpushed commits # ❌ Should have pushed earlier
|
||||||
|
|
||||||
|
# DON'T: Switch branches without pushing current work
|
||||||
|
git checkout feature/payment-system # ❌ Without pushing current branch first
|
||||||
|
|
||||||
|
# DON'T: Make massive commits
|
||||||
|
git add .
|
||||||
|
git commit -m "Complete entire user system" # ❌ Too broad, break it down
|
||||||
|
|
||||||
|
# DON'T: Create tags without annotations
|
||||||
|
git tag milestone-1 # ❌ No description of what was accomplished
|
||||||
|
git push origin milestone-1
|
||||||
|
|
||||||
|
# DON'T: Forget to push tags
|
||||||
|
git tag -a bootstrap-complete -m "Setup complete"
|
||||||
|
# ❌ Missing: git push origin bootstrap-complete
|
||||||
|
```
|
||||||
|
|
||||||
|
### 🔧 **Workflow Examples**
|
||||||
|
|
||||||
|
**Starting new feature:**
|
||||||
|
```bash
|
||||||
|
git checkout main
|
||||||
|
git pull origin main
|
||||||
|
git checkout -b feature/shopping-cart
|
||||||
|
# Work, commit frequently, push every ~10 commits
|
||||||
|
```
|
||||||
|
|
||||||
|
**Switching between features:**
|
||||||
|
```bash
|
||||||
|
# Currently on feature/shopping-cart
|
||||||
|
git add .
|
||||||
|
git commit -m "Add item quantity validation"
|
||||||
|
git push origin feature/shopping-cart # ✅ Push before switching
|
||||||
|
git checkout feature/user-profile
|
||||||
|
```
|
||||||
|
|
||||||
|
**Preparing for integration:**
|
||||||
|
```bash
|
||||||
|
git checkout feature/shopping-cart
|
||||||
|
git push origin feature/shopping-cart
|
||||||
|
# Feature automatically merges to INTEGRATION-WIP
|
||||||
|
```
|
||||||
|
|
||||||
|
## Gitea Integration
|
||||||
|
|
||||||
|
This workflow is optimized for Gitea and utilizes:
|
||||||
|
- Branch protection rules
|
||||||
|
- Automatic merge capabilities for integration testing
|
||||||
|
- Manual review processes for production releases
|
62
docs/WORKLOG-LLM.md
Normal file
62
docs/WORKLOG-LLM.md
Normal file
@@ -0,0 +1,62 @@
|
|||||||
|
# WORKLOG - TEMPLATE VERSION
|
||||||
|
|
||||||
|
**STATUS:** 🚀 Ready for CTO AI Delegation
|
||||||
|
**BRANCH:** main (template fresh state)
|
||||||
|
**NEXT:** Setup git repo and create first feature branch
|
||||||
|
|
||||||
|
## CURRENT SESSION
|
||||||
|
- **Time:** [UPDATE_DATE] (active session)
|
||||||
|
- **Working:** [DESCRIBE_CURRENT_TASK]
|
||||||
|
- **Last:** [LAST_COMPLETED_TASK]
|
||||||
|
- **Next:** [NEXT_PLANNED_ACTION]
|
||||||
|
|
||||||
|
## INITIAL SETUP REQUIRED
|
||||||
|
**FIRST TIME WITH TEMPLATE:**
|
||||||
|
- [ ] Run `git init` in project directory
|
||||||
|
- [ ] Create and push main branch
|
||||||
|
- [ ] Create INTEGRATION-WIP and RELEASE branches
|
||||||
|
- [ ] Update this worklog with project details
|
||||||
|
|
||||||
|
## SESSION LOG
|
||||||
|
|
||||||
|
### [DATE] - Initial Project Setup
|
||||||
|
|
||||||
|
**Time Range:** [START] → [END]
|
||||||
|
**Branch:** [CURRENT_BRANCH]
|
||||||
|
**Agent:** [AI_AGENT_NAME]
|
||||||
|
|
||||||
|
#### Completed Tasks ✅
|
||||||
|
- [ ] [TASK_1_DESCRIPTION]
|
||||||
|
- [ ] [TASK_2_DESCRIPTION]
|
||||||
|
- [ ] [TASK_3_DESCRIPTION]
|
||||||
|
|
||||||
|
#### Currently Working On 🔄
|
||||||
|
- [ ] [CURRENT_TASK_1]
|
||||||
|
- [ ] [CURRENT_TASK_2]
|
||||||
|
|
||||||
|
#### Next Actions 📋
|
||||||
|
- [ ] [NEXT_ACTION_1]
|
||||||
|
- [ ] [NEXT_ACTION_2]
|
||||||
|
- [ ] [NEXT_ACTION_3]
|
||||||
|
|
||||||
|
## MILESTONES COMPLETED
|
||||||
|
|
||||||
|
| Date | Tag | Description |
|
||||||
|
|------|-----|-------------|
|
||||||
|
| [DATE] | `[TAG_NAME]` | [MILESTONE_DESCRIPTION] |
|
||||||
|
|
||||||
|
## PROJECT INFO
|
||||||
|
**Update these fields for your project:**
|
||||||
|
- **Project Name:** [PROJECT_NAME]
|
||||||
|
- **Repository:** [REPO_URL]
|
||||||
|
- **Platform:** [GitHub/Gitea/GitLab]
|
||||||
|
- **CTO:** [YOUR_NAME]
|
||||||
|
- **AI Agents Used:** [LIST_AI_TOOLS]
|
||||||
|
|
||||||
|
## LINKS
|
||||||
|
- Details: [CURRENTWORK-LLM.md](./CURRENTWORK-LLM.md)
|
||||||
|
- Human versions: [WORKLOG.md](./WORKLOG.md), [CURRENTWORK.md](./CURRENTWORK.md)
|
||||||
|
- Agent ref: [AGENT-LLM.MD](./AGENT-LLM.MD)
|
||||||
|
|
||||||
|
---
|
||||||
|
*Template for CTO AI delegation - Update all bracketed fields for your project*
|
61
docs/WORKLOG.md
Normal file
61
docs/WORKLOG.md
Normal file
@@ -0,0 +1,61 @@
|
|||||||
|
# Work Log
|
||||||
|
|
||||||
|
**Project:** CTO Repository Setup
|
||||||
|
**Started:** 2025-09-05
|
||||||
|
**Current Branch:** LLMBOOTSTRAP
|
||||||
|
|
||||||
|
## Current Status
|
||||||
|
|
||||||
|
| Field | Value |
|
||||||
|
|-------|-------|
|
||||||
|
| **Current Time** | 2025-09-05 (Session Active) |
|
||||||
|
| **Status** | ✅ Bootstrap+Docs Complete - Ready to commit/push/tag |
|
||||||
|
| **Last Completed** | Reorganized docs to clean structure with LLM versions |
|
||||||
|
| **Currently Working On** | Final commit and milestone tagging |
|
||||||
|
| **Next Up** | Commit LLMBOOTSTRAP branch, push all branches, tag milestone |
|
||||||
|
|
||||||
|
## Session Log
|
||||||
|
|
||||||
|
### 2025-09-05 - Initial Bootstrap Session
|
||||||
|
|
||||||
|
**Time Range:** Session start → Current
|
||||||
|
**Branch:** LLMBOOTSTRAP
|
||||||
|
**Agent:** Claude Code
|
||||||
|
|
||||||
|
#### Completed Tasks ✅
|
||||||
|
- [x] Created branch structure (LLMBOOTSTRAP, INTEGRATION-WIP, RELEASE)
|
||||||
|
- [x] Established git workflow documentation (GIT_WORKFLOW.MD)
|
||||||
|
- [x] Created comprehensive DO/DON'T examples
|
||||||
|
- [x] Added tagging guidelines for milestones
|
||||||
|
- [x] Built LLM-optimized AGENT.MD reference
|
||||||
|
- [x] Tagged first milestone: `bootstrap-complete`
|
||||||
|
- [x] Created worklog tracking system (WORKLOG.md, CURRENTWORK.md)
|
||||||
|
- [x] Reorganized all docs to clean docs/ directory structure
|
||||||
|
- [x] Created LLM-optimized versions of all documentation
|
||||||
|
|
||||||
|
#### Currently Working On 🔄
|
||||||
|
- [ ] Final commit of LLMBOOTSTRAP branch
|
||||||
|
- [ ] Pushing all branches to remote
|
||||||
|
- [ ] Tagging docs reorganization milestone
|
||||||
|
|
||||||
|
#### Next Actions 📋
|
||||||
|
- [ ] Commit current work to LLMBOOTSTRAP
|
||||||
|
- [ ] Push LLMBOOTSTRAP branch
|
||||||
|
- [ ] Ensure all branches are pushed
|
||||||
|
- [ ] Tag `docs-reorganized` milestone
|
||||||
|
|
||||||
|
## Milestones Completed
|
||||||
|
|
||||||
|
| Date | Tag | Description |
|
||||||
|
|------|-----|-------------|
|
||||||
|
| 2025-09-05 | `bootstrap-complete` | Initial project structure and git workflow setup completed |
|
||||||
|
|
||||||
|
## Links
|
||||||
|
|
||||||
|
- **Detailed Current Work Notes:** [CURRENTWORK.md](./CURRENTWORK.md)
|
||||||
|
- **Git Workflow:** [GIT_WORKFLOW.MD](./GIT_WORKFLOW.MD)
|
||||||
|
- **Agent Reference:** [AGENT.MD](./AGENT.MD)
|
||||||
|
- **LLM Optimized Versions:** [WORKLOG-LLM.md](./WORKLOG-LLM.md), [CURRENTWORK-LLM.md](./CURRENTWORK-LLM.md), [AGENT-LLM.MD](./AGENT-LLM.MD)
|
||||||
|
|
||||||
|
---
|
||||||
|
*Last Updated: 2025-09-05 (Auto-updated by AI agents)*
|
Reference in New Issue
Block a user