WORKONMAIN BRANCH IMPLEMENTATION: ✅ Created long-lived development branch for framework improvements ✅ Clean separation between template usage and repository development ✅ Fixed all broken links in main branch README ✅ Created dual-purpose README (template users vs contributors) ✅ Added comprehensive CONTRIBUTING.md for developers MAIN BRANCH CLEANUP: ✅ Section 1: Clear template user instructions (download releases, don't clone) ✅ Section 2: Repository developer instructions (WORKONMAIN workflow) ✅ Working links to LICENSE and CONTRIBUTING.md (exist on main) ✅ Proper Gitea release links (../../releases/latest) DOCUMENTATION UPDATES: ✅ Updated WORKLOG-LLM.md with current status and milestones ✅ Updated TODO-LLM.md with WORKONMAIN branch completion ✅ Updated AGENT-LLM.MD branch structure to include WORKONMAIN ✅ Maintained documentation currency as requested BRANCH STRUCTURE COMPLETE: - main: Clean template baseline (no broken links) - WORKONMAIN: Framework development (full feature set) - LLMBOOTSTRAP: Feature development branch - Template users download releases, contributors use WORKONMAIN Ready for production template usage and framework development.
148 lines
5.2 KiB
Markdown
148 lines
5.2 KiB
Markdown
# AI AGENT REFERENCE - TEMPLATE VERSION
|
|
|
|
**FOR: Gemini-CLI, Claude, OpenCode, all AI tools working with CTO delegation template**
|
|
|
|
## 🚨 MANDATORY FIRST STEP - BOOTSTRAP PROCESS
|
|
**EVERY AI AGENT MUST EXECUTE THIS EXACT SEQUENCE IMMEDIATELY:**
|
|
|
|
### Step 1: Git Repository Setup (REQUIRED)
|
|
```bash
|
|
git init
|
|
git add .
|
|
git commit -m "Initial commit from CTO delegation template"
|
|
git branch -M main
|
|
git remote add origin YOUR_REPO_URL
|
|
git push -u origin main
|
|
```
|
|
|
|
### Step 2: Create Bootstrap Branch (REQUIRED)
|
|
```bash
|
|
git checkout -b bootstrap
|
|
git push -u origin bootstrap
|
|
```
|
|
|
|
### Step 3: Create Workflow Branches (REQUIRED)
|
|
```bash
|
|
git checkout -b INTEGRATION-WIP && git push -u origin INTEGRATION-WIP
|
|
git checkout -b RELEASE && git push -u origin RELEASE
|
|
git checkout bootstrap
|
|
```
|
|
|
|
### Step 4: Update Template Files (REQUIRED)
|
|
**You MUST update these template placeholders IMMEDIATELY:**
|
|
1. Update `docs/WORKLOG-LLM.md` - Fill ALL `[BRACKETED_FIELDS]`
|
|
2. Update `docs/CURRENTWORK-LLM.md` - Fill project info section
|
|
3. Commit bootstrap setup:
|
|
```bash
|
|
git add .
|
|
git commit -m "Bootstrap: Initialize project with CTO delegation template"
|
|
git push origin bootstrap
|
|
```
|
|
|
|
### Step 5: Tag Bootstrap Milestone (REQUIRED)
|
|
```bash
|
|
git tag -a bootstrap-complete -m "CTO delegation template bootstrap completed - project ready for AI development"
|
|
git push origin bootstrap-complete
|
|
```
|
|
|
|
**⚠️ CRITICAL: You are now on `bootstrap` branch and MUST remain here for initial project setup work.**
|
|
|
|
## CRITICAL RULES
|
|
1. **NEVER TOUCH `main` BRANCH** - Main is HUMAN-ONLY, AI agents use `bootstrap` as base
|
|
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 bootstrap
|
|
git pull origin bootstrap
|
|
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 (ALWAYS PUSH):**
|
|
```bash
|
|
git tag -a MILESTONE-NAME -m "DETAILED_DESCRIPTION_OF_COMPLETION"
|
|
git push origin MILESTONE-NAME
|
|
```
|
|
|
|
## BRANCH STRUCTURE (CREATED BY BOOTSTRAP)
|
|
- **`main`** - **HUMAN-ONLY** - Never touched by AI agents (clean template baseline)
|
|
- **`bootstrap`** - AI agents' base branch for template usage (created during bootstrap)
|
|
- **`WORKONMAIN`** - Framework development branch (for repository contributors only)
|
|
- **`INTEGRATION-WIP`** - Auto-merge target for testing features
|
|
- **`RELEASE`** - Manual PR target for production releases
|
|
- **`feature/TASK-NAME`** - All development work branches from bootstrap (descriptive names)
|
|
|
|
## DETERMINISTIC WORKFLOW
|
|
|
|
### Phase 1: Bootstrap (FIRST SESSION ONLY)
|
|
1. **Execute mandatory bootstrap process above** (Steps 1-5)
|
|
2. **Work on bootstrap branch** for initial template setup
|
|
3. **Add READYSET and template files** (future enhancement)
|
|
4. **Tag bootstrap-complete** when setup finished
|
|
|
|
### Phase 2: Feature Development (ONGOING)
|
|
1. **Always start from bootstrap:** `git checkout bootstrap && git pull origin bootstrap`
|
|
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
|
|
|
|
### Phase 3: Integration & Release
|
|
1. **Features auto-merge to INTEGRATION-WIP** (testing)
|
|
2. **Manual PRs to RELEASE** (production)
|
|
3. **Never delete any branches** (complete history preservation)
|
|
|
|
## 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)
|
|
|
|
**ALWAYS push tags immediately:**
|
|
```bash
|
|
git tag -a TAG-NAME -m "DESCRIPTION"
|
|
git push origin TAG-NAME
|
|
```
|
|
|
|
## 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 |