diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..c44ebf9 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,284 @@ +# 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.* \ No newline at end of file diff --git a/README.md b/README.md index f450e75..ffcb906 100644 --- a/README.md +++ b/README.md @@ -1,109 +1,103 @@ -# CTO +# CTO AI Delegation Framework -**Prompts and code for founder CTO who want to delegate to AI as an entire team.** - -*A well-structured repository with comprehensive git workflow and AI agent integration* - -## ๐Ÿ—๏ธ Repository Structure - -This repository follows a clean, organized structure with proper documentation and workflow management. - -``` -CTO/ -โ”œโ”€โ”€ README.md (this file) -โ”œโ”€โ”€ LICENSE -โ””โ”€โ”€ docs/ (comprehensive documentation - see feature branches) -``` - -## ๐ŸŒณ Branch Structure - -| Branch | Purpose | Status | Description | -|--------|---------|--------|-------------| -| **`main`** | ๐Ÿ”’ **Stable** | Protected | Main stable branch - no direct commits | -| **`LLMBOOTSTRAP`** | ๐Ÿš€ **Active** | Feature | Initial setup and bootstrap work | -| **`INTEGRATION-WIP`** | ๐Ÿ”„ **Integration** | Auto-merge | Continuous integration testing | -| **`RELEASE`** | ๐Ÿ“ฆ **Production** | Manual-only | Production-ready releases | - -## ๐Ÿ“‹ Getting Started - -### For Founder CTOs - -This repository provides a complete framework for delegating development work to AI agents while maintaining professional standards: - -1. **Structured AI Delegation:** Complete workflow for AI team management -2. **Professional Git Practices:** Enterprise-grade branching and documentation -3. **Dual Documentation:** Human-readable and LLM-optimized references - -### For Developers & AI Agents - -1. **Never work on `main`** - Always create feature branches -2. **Clone and setup:** - ```bash - git clone - cd CTO - git checkout LLMBOOTSTRAP # See current work - ``` - -**AI Agents:** See `docs/AGENT-LLM.MD` in feature branches for optimized instructions. - -## ๐Ÿ“š Documentation - -Complete documentation is available in the `docs/` directory on feature branches: - -### Human-Readable Documentation -- **`docs/GIT_WORKFLOW.MD`** - Comprehensive git workflow with examples -- **`docs/AGENT.MD`** - AI agent guidelines and workflow reference -- **`docs/WORKLOG.md`** - Project progress and milestone tracking -- **`docs/CURRENTWORK.md`** - Detailed session notes and concerns - -### LLM-Optimized Documentation -- **`docs/AGENT-LLM.MD`** - Condensed AI agent reference -- **`docs/WORKLOG-LLM.md`** - Quick status and progress updates -- **`docs/CURRENTWORK-LLM.md`** - Streamlined session notes - -## ๐Ÿท๏ธ Milestones & Tags - -| Tag | Date | Description | -|-----|------|-------------| -| `bootstrap-complete` | 2025-09-05 | Initial project structure and workflow setup | - -View all tags: `git tag -l` - -## ๐Ÿ”ง AI Team Management Workflow - -1. **Feature Development:** AI agents create branches from `main` for all work -2. **Integration Testing:** Features auto-merge to `INTEGRATION-WIP` -3. **Production Release:** Manual PR review required for `RELEASE` -4. **Branch Preservation:** Never auto-delete feature branches -5. **Milestone Tracking:** Tag important stages and achievements - -## ๐Ÿค– AI Agent Integration - -This repository is optimized for AI-assisted development: - -- **Platform Compatibility:** Gemini-CLI, Claude, OpenCode -- **LLM-Optimized Docs:** Streamlined references for AI consumption -- **Automated Workflows:** Structured processes for consistent AI development -- **Work Tracking:** Built-in logging for session continuity - -## ๐Ÿ”— Quick Links - -**To explore the project:** -1. Switch to `LLMBOOTSTRAP` branch: `git checkout LLMBOOTSTRAP` -2. Review documentation in `docs/` directory -3. Check current status in `docs/WORKLOG.md` - -**For AI agents:** -1. Primary reference: `docs/AGENT-LLM.MD` -2. Quick status: `docs/WORKLOG-LLM.md` - -## ๐Ÿ“Š Repository Stats - -- **Platform:** Gitea -- **Created:** 2025-09-05 -- **Purpose:** AI team delegation framework -- **AI-Friendly:** โœ… Optimized for LLM consumption +**Prompts and code for founder CTOs who want to delegate to AI as an entire team.** --- -*This repository maintains dual documentation (human + LLM optimized) and follows strict workflow preservation practices for professional AI team management.* \ No newline at end of file +## ๐ŸŽฏ **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* \ No newline at end of file