Skip to content

AGENTS.md

Latest commit

 

History

History
92 lines (71 loc) · 3.73 KB

AGENTS.md

File metadata and controls

92 lines (71 loc) · 3.73 KB

AGENTS.md - Ring for OpenCode

This file provides guidance to OpenCode when working with code in this repository.

Overview

Ring is a comprehensive skills library that enforces proven software engineering practices through mandatory workflows, parallel code review, and systematic development.

Available Skills

Skills are loaded on-demand via the native skill tool. See assets/skill/ for available skills.

Core Skills

  • ring:test-driven-development - RED-GREEN-REFACTOR methodology
  • ring:brainstorming - Socratic design refinement
  • ring:requesting-code-review - Parallel 6-reviewer code review
  • ring:executing-plans - Batch task execution with checkpoints
  • ring:using-pm-team - Pre-dev planning workflow (4-gate & 9-gate tracks)
  • ring:visual-explainer - Generate visual HTML diagrams and data tables

Development Workflow

  1. Use ring:brainstorming (or ring:pre-dev-feature/ring:pre-dev-full) to plan
  2. Use ring:test-driven-development for implementation
  3. Use ring:requesting-code-review before merging

Available Agents

Agents are invoked via @ mention or automatically by primary agents.

Research Agents (subagents)

  • @ring:repo-research-analyst - Codebase patterns and conventions
  • @ring:best-practices-researcher - External best practices and industry standards
  • @ring:framework-docs-researcher - Tech stack documentation and versions

Reviewers (subagents)

  • @ring:code-reviewer - Code quality, architecture, design patterns
  • @ring:business-logic-reviewer - Business rules, domain correctness
  • @ring:security-reviewer - Security vulnerabilities, data protection
  • @ring:test-reviewer - Test quality, coverage, anti-patterns
  • @ring:nil-safety-reviewer - Nil/null pointer safety (Go and TypeScript)
  • @ring:consequences-reviewer - Ripple effects, caller chain impact, downstream breakage

Specialist Agents (subagents)

  • @ring:codebase-explorer - Codebase exploration and analysis
  • @ring:write-plan - Implementation planning

Engineering Agents (subagents)

  • @ring:backend-engineer-golang - Go backend development
  • @ring:backend-engineer-typescript - TypeScript backend development
  • @ring:frontend-engineer - Frontend development
  • @ring:frontend-designer - UI/UX implementation
  • @ring:devops-engineer - Infrastructure and CI/CD
  • @ring:qa-analyst - Testing and quality assurance
  • @ring:sre - Site reliability engineering

Available Commands

Commands are invoked via /ring:command-name.

  • /ring:commit - Atomic commits with intelligent grouping
  • /ring:codereview - Dispatch all 6 reviewers in parallel
  • /ring:brainstorm - Start design refinement session
  • /ring:pre-dev-feature - Plan small feature (<2 days, 4 gates)
  • /ring:pre-dev-full - Plan large feature (≥2 days, 9 gates)
  • /ring:execute-plan - Batch task execution
  • /ring:write-plan - Create implementation plans
  • /ring:lint - Run lint checks with auto-fix
  • /ring:md-to-html - Transform a markdown file into a standalone, styled HTML page
  • /ring:explore-codebase - Deep codebase analysis
  • /ring:create-handoff - Session state handoff
  • /ring:resume-handoff - Resume from handoff
  • /ring:dev-cycle - Full development cycle
  • /ring:dev-refactor - Codebase refactoring
  • /ring:dev-status - Check development cycle status
  • /ring:dev-report - Generate development report
  • /ring:dev-cancel - Cancel development cycle
  • /ring:worktree - Manage git worktrees

Compliance Rules

  • TDD: Test must fail before implementation
  • Review: All 6 reviewers must pass
  • Commits: Use conventional commit format

Key Principles

  1. DRY - Don't Repeat Yourself
  2. YAGNI - You Aren't Gonna Need It
  3. TDD - Test-Driven Development
  4. Frequent commits - Small, atomic changes