Skip to content

Mandatory workflow system enforcing software engineering best practices and quality gates for AI agents.

Notifications You must be signed in to change notification settings

LerianStudio/ring

Repository files navigation

💍 The Ring - Skills Library for AI Agents

Proven engineering practices, enforced through skills.

Ring is a comprehensive skills library and workflow system for AI agents that transforms how AI assistants approach software development. Currently implemented as a Claude Code plugin marketplace with 7 active plugins (see .claude-plugin/marketplace.json for current versions), the skills themselves are agent-agnostic and can be used with any AI agent system. Ring provides battle-tested patterns, mandatory workflows, and systematic approaches to common development tasks.

✨ Why Ring?

Without Ring, AI assistants often:

  • Skip tests and jump straight to implementation
  • Make changes without understanding root causes
  • Claim tasks are complete without verification
  • Forget to check for existing solutions
  • Repeat known mistakes

Ring solves this by:

  • Enforcing proven workflows - Test-driven development, systematic debugging, proper planning
  • Providing 55 specialized skills - From brainstorming to production deployment (21 core + 10 dev-team + 10 product planning + 6 FinOps + 1 ralph-wiggum + 7 technical writing)
  • 20 specialized agents - 5 review/planning agents + 7 developer agents + 3 research agents + 2 FinOps agents + 3 technical writing agents
  • Automating skill discovery - Skills load automatically at session start
  • Preventing common failures - Built-in anti-patterns and mandatory checklists

🤖 Specialized Agents

Review & Planning Agents (default plugin):

  • ring-default:code-reviewer - Foundation review (architecture, code quality, design patterns)
  • ring-default:business-logic-reviewer - Correctness review (domain logic, requirements, edge cases)
  • ring-default:security-reviewer - Safety review (vulnerabilities, OWASP, authentication)
  • ring-default:write-plan - Implementation planning agent
  • ring-default:codebase-explorer - Deep architecture analysis (Opus-powered, complements built-in Explore)
  • Use /ring-default:codereview command to orchestrate parallel review workflow

Developer Agents (dev-team plugin):

  • ring-dev-team:backend-engineer-golang - Go backend specialist for financial systems
  • ring-dev-team:backend-engineer-typescript - TypeScript/Node.js backend specialist (Express, NestJS, Fastify)
  • ring-dev-team:devops-engineer - DevOps infrastructure specialist
  • ring-dev-team:frontend-engineer-typescript - TypeScript-first React/Next.js specialist
  • ring-dev-team:frontend-designer - Visual design specialist
  • ring-dev-team:qa-analyst - Quality assurance specialist
  • ring-dev-team:sre - Site reliability engineer

FinOps Agents (ring-finops-team plugin):

  • ring-finops-team:finops-analyzer - Financial operations analysis
  • ring-finops-team:finops-automation - FinOps template creation and automation

Technical Writing Agents (ring-tw-team plugin):

  • ring-tw-team:functional-writer - Functional documentation (guides, tutorials, conceptual docs)
  • ring-tw-team:api-writer - API reference documentation (endpoints, schemas, examples)
  • ring-tw-team:docs-reviewer - Documentation quality review (voice, tone, structure, completeness)

Plugin versions are managed in .claude-plugin/marketplace.json

🖥️ Supported Platforms

Ring works across multiple AI development platforms:

Platform Format Status Features
Claude Code Native ✅ Source of truth Skills, agents, commands, hooks
Factory AI Transformed ✅ Supported Droids, commands, skills
Cursor Transformed ✅ Supported Rules, workflows
Cline Transformed ✅ Supported Prompts

Transformation Notes:

  • Claude Code receives Ring content in its native format
  • Factory AI: agentsdroids terminology
  • Cursor: Skills/agents → .cursorrules and workflows
  • Cline: All content → structured prompts

Platform-Specific Guides:

🚀 Quick Start

Multi-Platform Installation (Recommended)

The Ring installer automatically detects installed platforms and transforms content appropriately.

Linux/macOS/Git Bash:

# Interactive installer (auto-detects platforms)
curl -fsSL https://raw.githubusercontent.com/lerianstudio/ring/main/install-ring.sh | bash

# Or clone and run locally
git clone https://github.com/lerianstudio/ring.git ~/ring
cd ~/ring
./installer/install-ring.sh

Windows PowerShell:

# Interactive installer (auto-detects platforms)
irm https://raw.githubusercontent.com/lerianstudio/ring/main/install-ring.ps1 | iex

# Or clone and run locally
git clone https://github.com/lerianstudio/ring.git $HOME\ring
cd $HOME\ring
.\installer\install-ring.ps1

Direct Platform Installation

Install to specific platforms without the interactive menu:

# Install to Claude Code only (native format)
./installer/install-ring.sh install --platforms claude

# Install to Factory AI only (droids format)
./installer/install-ring.sh install --platforms factory

# Install to multiple platforms
./installer/install-ring.sh install --platforms claude,cursor,cline

# Install to all detected platforms
./installer/install-ring.sh install --platforms auto

# Dry run (preview changes without installing)
./installer/install-ring.sh install --platforms auto --dry-run

Installer Commands

# List installed platforms and versions
./installer/install-ring.sh list

# Update existing installation
./installer/install-ring.sh update

# Check for available updates
./installer/install-ring.sh check

# Sync (update only changed files)
./installer/install-ring.sh sync

# Uninstall from specific platform
./installer/install-ring.sh uninstall --platforms cursor

# Detect available platforms
./installer/install-ring.sh detect

Claude Code Plugin Marketplace

For Claude Code users, you can also install from the marketplace:

  • Open Claude Code
  • Go to Settings → Plugins
  • Search for "ring"
  • Click Install

Manual Installation (Claude Code only)

# Clone the marketplace repository
git clone https://github.com/lerianstudio/ring.git ~/ring

# Skills auto-load at session start via hooks
# No additional configuration needed for Claude Code

First Session

When you start a new Claude Code session with Ring installed, you'll see:

## Available Skills:
- using-ring (Check for skills BEFORE any task)
- test-driven-development (RED-GREEN-REFACTOR cycle)
- systematic-debugging (4-phase root cause analysis)
- verification-before-completion (Evidence before claims)
... and 44 more skills

🎯 Core Skills

The Big Four (Use These First!)

1. using-ring - Mandatory Skill Discovery

Before ANY action → Check skills
Before ANY tool → Check skills
Before ANY code → Check skills

2. test-driven-development - Test First, Always

RED → Write failing test → Watch it fail
GREEN → Minimal code → Watch it pass
REFACTOR → Clean up → Stay green

3. systematic-debugging - Find Root Cause

Phase 1: Investigate (gather ALL evidence)
Phase 2: Analyze patterns
Phase 3: Test hypothesis (one at a time)
Phase 4: Implement fix (with test)

4. verification-before-completion - Prove It Works

Run command → Paste output → Then claim
No "should work" → Only "does work" with proof

📚 All 48 Skills (Across 7 Plugins)

Core Skills (ring-default plugin - 21 skills)

Testing & Debugging (6):

  • test-driven-development - Write test first, watch fail, minimal code
  • systematic-debugging - 4-phase root cause investigation
  • verification-before-completion - Evidence before claims
  • testing-anti-patterns - Common test pitfalls to avoid
  • condition-based-waiting - Replace timeouts with conditions
  • defense-in-depth - Multi-layer validation

Collaboration & Planning (10):

  • brainstorming - Structured design refinement
  • writing-plans - Zero-context implementation plans
  • executing-plans - Batch execution with checkpoints
  • requesting-code-review - Parallel 3-reviewer dispatch with severity-based handling
  • receiving-code-review - Responding to feedback
  • dispatching-parallel-agents - Concurrent workflows
  • subagent-driven-development - Fast iteration with parallel reviews
  • using-git-worktrees - Isolated development
  • finishing-a-development-branch - Merge/PR decisions
  • root-cause-tracing - Backward bug tracking

Meta Skills (4):

  • using-ring - Mandatory skill discovery
  • writing-skills - TDD for documentation
  • testing-skills-with-subagents - Skill validation
  • testing-agents-with-subagents - Subagent-specific testing

Developer Skills (ring-dev-team plugin - 10 skills)

Code Development:

  • ring-dev-team:using-dev-team - Introduction to developer specialist agents
  • ring-dev-team:dev-refactor - Codebase analysis against standards
  • ring-dev-team:dev-cycle - 6-gate development workflow orchestrator

6-Gate Workflow Skills:

  • ring-dev-team:dev-implementation - Gate 0: TDD implementation
  • ring-dev-team:dev-devops - Gate 1: DevOps setup (Docker, compose)
  • ring-dev-team:dev-sre - Gate 2: Observability setup
  • ring-dev-team:dev-testing - Gate 3: Test coverage
  • ring-dev-team:dev-review - Gate 4: Parallel code review
  • ring-dev-team:dev-validation - Gate 5: User approval
  • ring-dev-team:dev-feedback-loop - Assertiveness scoring and metrics

Product Planning Skills (ring-pm-team plugin - 10 skills)

Pre-Development Workflow (includes using-pm-team + 9 gates):

  • using-pm-team - Introduction to product planning workflow
  1. pre-dev-research - Research phase (parallel agents)
  2. pre-dev-prd-creation - Business requirements (WHAT/WHY)
  3. pre-dev-feature-map - Feature relationships
  4. pre-dev-trd-creation - Technical architecture (HOW)
  5. pre-dev-api-design - Component contracts
  6. pre-dev-data-model - Entity relationships
  7. pre-dev-dependency-map - Technology selection
  8. pre-dev-task-breakdown - Work increments
  9. pre-dev-subtask-creation - Atomic units

FinOps & Regulatory Skills (ring-finops-team plugin - 6 skills)

Regulatory Templates (6):

  • using-finops-team - Introduction to FinOps team workflow
  • regulatory-templates - Brazilian regulatory orchestration (BACEN, RFB)
  • regulatory-templates-setup - Template selection initialization
  • regulatory-templates-gate1 - Compliance analysis and field mapping
  • regulatory-templates-gate2 - Field mapping validation
  • regulatory-templates-gate3 - Template file generation

Ralph Wiggum (ralph-wiggum plugin - 1 skill)

Iterative Development:

  • using-ralph-wiggum - Ralph Wiggum iterative loop technique guide

Technical Writing Skills (ring-tw-team plugin - 7 skills)

Documentation Creation:

  • using-tw-team - Introduction to technical writing specialists
  • writing-functional-docs - Patterns for guides, tutorials, conceptual docs
  • writing-api-docs - API reference documentation patterns
  • documentation-structure - Document hierarchy and organization
  • voice-and-tone - Voice and tone guidelines (assertive, encouraging, human)
  • documentation-review - Quality checklist and review process
  • api-field-descriptions - Field description patterns by type

🎮 Interactive Commands

Ring provides 15 slash commands across 4 plugins for common workflows.

Core Workflows (ring-default)

  • /ring-default:codereview [files-or-paths] - Dispatch 3 parallel code reviewers for comprehensive review
  • /ring-default:codify [description] - Document a solved problem to build searchable knowledge base
  • /ring-default:commit [message] - Create git commit with AI identification via Git trailers
  • /ring-default:worktree [branch-name] - Create isolated git workspace for parallel development
  • /ring-default:brainstorm [topic] - Interactive design refinement using Socratic method
  • /ring-default:write-plan [feature] - Create detailed implementation plan with bite-sized tasks
  • /ring-default:execute-plan [path] - Execute plan in batches with review checkpoints

Product Planning (ring-pm-team)

  • /ring-pm-team:pre-dev-feature [feature-name] - Lightweight 4-gate pre-dev workflow for small features (<2 days)
  • /ring-pm-team:pre-dev-full [feature-name] - Complete 9-gate pre-dev workflow for large features (>=2 days)

Ralph Wiggum (Iterative AI Loops)

  • /ralph-wiggum:ralph-loop "PROMPT" --max-iterations N --completion-promise "TEXT" - Start autonomous iterative loop
  • /ralph-wiggum:cancel-ralph - Cancel active Ralph loop
  • /ralph-wiggum:help - Explain Ralph technique and examples

Technical Writing (ring-tw-team)

  • /ring-tw-team:write-guide [topic] - Start writing a functional guide with voice/tone guidance
  • /ring-tw-team:write-api [endpoint] - Start writing API reference documentation
  • /ring-tw-team:review-docs [file] - Review existing documentation for quality

💡 Usage Examples

Building a Feature

User: "Add user authentication to the app"
Claude: I'm using the brainstorming skill to design this feature...
        [Structured exploration of requirements]
Claude: I'm using test-driven-development to implement...
        [RED-GREEN-REFACTOR cycle for each component]
Claude: I'm using verification-before-completion to confirm...
        [Runs tests, shows actual output]

Fixing a Bug

User: "The app crashes when clicking submit"
Claude: I'm using systematic-debugging to investigate...
        Phase 1: [Gathering evidence]
        Phase 2: [Pattern analysis]
        Phase 3: [Hypothesis testing]
        Phase 4: [Implementing fix with test]

Planning a Project

User: "Plan an e-commerce platform"
Claude: I'll use the pre-dev workflow to plan this systematically...
        Gate 1: PRD Creation [Business requirements]
        Gate 2: Feature Map [Domain groupings]
        Gate 3: TRD Creation [Architecture patterns]
        ... [Through all 8 gates]

Code Review (Parallel, 3x Faster!)

User: "Review my authentication implementation"
Claude: Dispatching all 3 reviewers in parallel...
        [Launches ring-default:code-reviewer, ring-default:business-logic-reviewer, ring-default:security-reviewer simultaneously]

        Code reviewer: PASS. Clean architecture, good tests.
        Business reviewer: FAIL. Missing password reset flow (HIGH severity).
        Security reviewer: FAIL. JWT secret hardcoded (CRITICAL severity).

        Aggregating issues by severity:
        - CRITICAL: JWT secret hardcoded in auth.ts:42
        - HIGH: Password reset flow missing from requirements

        Dispatching fix subagent to address Critical/High issues...
        [Fixes applied]

        Re-running all 3 reviewers in parallel...
        All reviewers: PASS. Ready for production.

Key benefits:

  • 3x faster - All reviewers run simultaneously (not sequential)
  • Comprehensive - Get all feedback at once, easier to prioritize
  • Tech debt tracking - Low/Cosmetic issues tracked with TODO/FIXME comments in code
  • Model-specific - All reviewers run on Opus for deep analysis

🏗️ Architecture

Monorepo Marketplace - Multiple specialized plugin collections:

ring/                                  # Monorepo root
├── .claude-plugin/
│   └── marketplace.json              # Multi-plugin marketplace config (7 active plugins)
├── default/                          # Core Ring plugin (ring-default)
│   ├── skills/                       # 21 core skills
│   │   ├── skill-name/
│   │   │   └── SKILL.md             # Skill definition with frontmatter
│   │   └── shared-patterns/         # Universal patterns (5 patterns)
│   ├── commands/                    # 7 slash command definitions
│   ├── hooks/                       # Session initialization
│   │   ├── hooks.json              # Hook configuration
│   │   ├── session-start.sh        # Loads skills at startup
│   │   └── generate-skills-ref.py  # Auto-generates quick reference
│   ├── agents/                      # 5 specialized agents
│   │   ├── code-reviewer.md        # Foundation review (parallel)
│   │   ├── business-logic-reviewer.md  # Correctness review (parallel)
│   │   ├── security-reviewer.md    # Safety review (parallel)
│   │   ├── write-plan.md           # Implementation planning
│   │   └── codebase-explorer.md    # Deep architecture analysis (Opus)
│   ├── lib/                        # Infrastructure utilities (9 scripts)
│   └── docs/                       # Documentation
├── dev-team/                      # Developer Agents plugin (ring-dev-team)
│   └── agents/                      # 7 specialized developer agents
│       ├── backend-engineer-golang.md  # Go backend specialist
│       ├── backend-engineer-typescript.md # TypeScript/Node.js backend specialist
│       ├── devops-engineer.md          # DevOps infrastructure
│       ├── frontend-engineer-typescript.md # TypeScript-first React/Next.js specialist
│       ├── frontend-designer.md        # Visual design specialist
│       ├── qa-analyst.md               # Quality assurance
│       └── sre.md                      # Site reliability engineer
├── finops-team/                     # FinOps plugin (ring-finops-team)
│   ├── skills/                      # 6 regulatory compliance skills
│   │   └── regulatory-templates*/   # Brazilian regulatory compliance
│   ├── agents/                      # 2 FinOps agents
│   │   ├── finops-analyzer.md      # FinOps analysis
│   │   └── finops-automation.md    # FinOps automation
│   └── docs/
│       └── regulatory/             # Brazilian regulatory documentation
├── pm-team/                    # Product Planning plugin (ring-pm-team)
│   └── skills/                      # 10 pre-dev workflow skills
│       └── pre-dev-*/              # PRD, TRD, API, Data, Tasks
├── ralph-wiggum/                    # Iterative AI loops plugin (ralph-wiggum)
│   ├── commands/                    # 3 slash commands (ralph-loop, cancel-ralph, help)
│   ├── hooks/                       # SessionStart and Stop hooks
│   ├── scripts/                     # Setup utilities
│   └── skills/                      # using-ralph-wiggum skill
├── tw-team/                         # Technical Writing plugin (ring-tw-team)
│   ├── skills/                      # 7 documentation skills
│   ├── agents/                      # 3 technical writing agents
│   ├── commands/                    # 3 slash commands
│   └── hooks/                       # SessionStart hook
├── ops-team/                        # Team-specific skills (reserved)
└── pmm-team/                        # Team-specific skills (reserved)

🤝 Contributing

Adding a New Skill

For core Ring skills:

  1. Create the skill directory

    mkdir default/skills/your-skill-name
  2. Write SKILL.md with frontmatter

    ---
    name: your-skill-name
    description: |
      Brief description of WHAT this skill does (the method/technique).
      1-2 sentences maximum.
    
    trigger: |
      - Specific condition that mandates using this skill
      - Another trigger condition
      - Use quantifiable criteria when possible
    
    skip_when: |
      - When NOT to use this skill → alternative
      - Another exclusion condition
    
    sequence:
      after: [prerequisite-skill]   # Skills that should come before
      before: [following-skill]     # Skills that typically follow
    
    related:
      similar: [skill-that-seems-similar]      # Differentiate from these
      complementary: [skill-that-pairs-well]   # Use together with these
    ---
    
    # Skill content here...

    Schema fields explained:

    • name: Skill identifier (matches directory name)
    • description: WHAT the skill does (method/technique)
    • trigger: WHEN to use - specific, quantifiable conditions
    • skip_when: WHEN NOT to use - differentiates from similar skills
    • sequence: Workflow ordering (optional)
    • related: Similar/complementary skills for disambiguation (optional)
  3. Update documentation

    • Skills auto-load via default/hooks/generate-skills-ref.py
    • Test with session start hook
  4. Submit PR

    git checkout -b feat/your-skill-name
    git add default/skills/your-skill-name
    git commit -m "feat(skills): add your-skill-name for X"
    gh pr create

For product/team-specific skills:

  1. Create plugin structure

    mkdir -p product-xyz/{skills,agents,commands,hooks,lib}
  2. Register in marketplace Edit .claude-plugin/marketplace.json:

    {
      "name": "ring-product-xyz",
      "description": "Product XYZ specific skills",
      "version": "0.1.0",
      "source": "./product-xyz",
      "homepage": "https://github.com/lerianstudio/ring/tree/product-xyz"
    }
  3. Follow core plugin structure

    • Use same layout as default/
    • Create product-xyz/hooks/hooks.json for initialization
    • Add skills to product-xyz/skills/

Skill Quality Standards

  • Mandatory sections: When to use, How to use, Anti-patterns
  • Include checklists: TodoWrite-compatible task lists
  • Evidence-based: Require verification before claims
  • Battle-tested: Based on real-world experience
  • Clear triggers: Unambiguous "when to use" conditions

📖 Documentation

  • Skills Quick Reference - Auto-generated at session start from skill frontmatter
  • CLAUDE.md - Repository guide for Claude Code
  • MANUAL.md - Quick reference for all commands, agents, and workflows
  • Design Documents - Implementation plans and architecture decisions
  • Platform Guides:

🎯 Philosophy

Ring embodies these principles:

  1. Skills are mandatory, not optional - If a skill applies, it MUST be used
  2. Evidence over assumptions - Prove it works, don't assume
  3. Process prevents problems - Following workflows prevents known failures
  4. Small steps, verified often - Incremental progress with continuous validation
  5. Learn from failure - Anti-patterns document what doesn't work

📊 Success Metrics

Teams using Ring report:

  • 90% reduction in "works on my machine" issues
  • 75% fewer bugs reaching production
  • 60% faster debugging cycles
  • 100% of code covered by tests (enforced by TDD)

🙏 Acknowledgments

Ring is built on decades of collective software engineering wisdom, incorporating patterns from:

  • Extreme Programming (XP)
  • Test-Driven Development (TDD)
  • Domain-Driven Design (DDD)
  • Agile methodologies
  • DevOps practices

Special thanks to the Lerian Team for battle-testing these skills in production.

📄 License

MIT - See LICENSE file

🔗 Links


Remember: If a skill applies to your task, you MUST use it. This is not optional.

About

Mandatory workflow system enforcing software engineering best practices and quality gates for AI agents.

Resources

Stars

Watchers

Forks

Packages

No packages published

Contributors 5