Skip to main content

Production Readiness Workflow

Overview

Workflow for preparing a CODITECT project for production deployment. Ensures all standards are met and the project achieves Grade B (80+) or higher.

Prerequisites

  • Project repository exists
  • Basic structure in place
  • Git repository initialized

Workflow Phases

Phase 1: Audit (30-60 min)

Objective: Assess current production readiness.

Steps

  1. Run Production Audit

    /production-audit
    # Or
    python H.P.004-SCRIPTS/production-readiness-check.py --report
  2. Document Current State

    • Current score
    • Grade
    • Blocking issues
    • High priority items
  3. Categorize Issues

    PriorityFix WithinImpact
    CriticalImmediatelyBlocking deployment
    HighSame dayMajor deficiency
    MediumThis sprintShould fix
    LowWhen convenientNice to have
  4. Create Remediation Plan

    • Order by priority
    • Estimate time per fix
    • Identify dependencies

Deliverables

  • Audit report saved
  • Issues categorized
  • Remediation plan created
  • Time estimates documented

Phase 2: Remediation (1-2 hours)

Objective: Fix issues to achieve production readiness.

Steps

  1. Fix Critical Issues

    Missing CLAUDE.md:

    # Create from template
    cp .coditect/CODITECT-CORE-STANDARDS/H.P.008-TEMPLATES/CLAUDE-MD-TEMPLATE.md CLAUDE.md
    # Customize for project

    Exposed Secrets:

    # Remove from repository
    git rm --cached secrets.json
    # Add to .gitignore
    echo "secrets.json" >> .gitignore

    No CI/CD:

    mkdir -p .github/H.P.006-WORKFLOWS
    # Create basic workflow
  2. Fix High Priority Issues

    Missing README:

    /readme-gen --template comprehensive

    No Tests Directory:

    mkdir tests
    touch tests/__init__.py
    touch tests/test_example.py
  3. Fix Documentation Issues

    # Generate missing READMEs
    /readme-gen --missing --recursive

    # Fix CLAUDE.md if too long
    # (Manually edit to under 200 lines)
  4. Fix Organization Issues

    # Move stray files
    /organize --execute

    # Fix naming
    /naming-check --fix
  5. Commit Fixes

    git add -A
    git commit -m "chore: Fix production readiness issues

    - Created CLAUDE.md
    - Added missing READMEs
    - Fixed naming conventions
    - Added CI/CD workflow"

Deliverables

  • All critical issues fixed
  • High priority issues fixed
  • Medium priority issues addressed
  • Changes committed

Phase 3: Verification (30 min)

Objective: Confirm production readiness achieved.

Steps

  1. Re-run Production Audit

    /production-audit --report
  2. Verify Success Criteria

    CriteriaRequiredActual
    Score≥80___
    Blocking Issues0___
    README Coverage≥80%___
  3. Final Approval

    • Review audit report
    • Confirm no blocking issues
    • Sign off on production readiness

Deliverables

  • Final audit score ≥80
  • No blocking issues remain
  • Production readiness confirmed

Quick Fixes Reference

Missing CLAUDE.md

# Project Name

## Quick Reference
| Action | Command |
|--------|---------|
| Run | `npm start` |
| Test | `npm test` |

## Key Files
- `src/index.ts` - Entry point

---
Last Updated: YYYY-MM-DD

Missing .gitignore

# Dependencies
node_modules/
.venv/
__pycache__/

# Environment
.env
.env.local

# Build
dist/
build/

# IDE
.idea/
.vscode/

# OS
.DS_Store
Thumbs.db

# Logs
*.log

Basic CI/CD Workflow

# .github/H.P.006-WORKFLOWS/ci.yml
name: CI

on: [push, pull_request]

jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Setup
run: npm install
- name: Test
run: npm test
- name: Build
run: npm run build

Scoring Guide

How to Improve Score

FromToActions
F (<60)D (60-69)Add README, LICENSE, .gitignore
DC (70-79)Add CLAUDE.md, docs/, basic structure
CB (80-84)Full README coverage, no stray files
BA (90+)CI/CD, tests, linting, full compliance

Agents Used

AgentPurpose
production-readiness-auditorRun audit
readme-generatorCreate READMEs
naming-convention-enforcerFix naming
file-reorganization-orchestratorMove files


Version: 1.0.0 Created: 2026-01-02 Author: CODITECT Core Team