diff --git a/.github/agents/developer.instructions.md b/.github/agents/developer.instructions.md index 9b43ce543f..06c5a24c6e 100644 --- a/.github/agents/developer.instructions.md +++ b/.github/agents/developer.instructions.md @@ -725,4 +725,4 @@ For detailed specifications, see individual files in `specs/`: --- -**Last Updated**: 2026-01-24 +**Last Updated**: 2026-01-28 diff --git a/specs/agents/hierarchical-agents-quickstart.md b/specs/agents/hierarchical-agents-quickstart.md index 1f0f79bfed..6832ee97aa 100644 --- a/specs/agents/hierarchical-agents-quickstart.md +++ b/specs/agents/hierarchical-agents-quickstart.md @@ -146,7 +146,7 @@ graph TD 3. Agent Performance Analyzer identifies the agent has quality issues in this workflow 4. Result: Single coordinated issue created referencing all three perspectives -**You don't need to do anything** - the coordination happens automatically through shared memory! +**You don't need to do anything** - the coordination happens automatically through shared memory. ## Quick Actions diff --git a/specs/agents/hierarchical-agents.md b/specs/agents/hierarchical-agents.md index aa3c096a79..ad7813cc04 100644 --- a/specs/agents/hierarchical-agents.md +++ b/specs/agents/hierarchical-agents.md @@ -4,7 +4,7 @@ This document describes the hierarchical agent management system in GitHub Agent ## Overview -The hierarchical agent system consists of specialized meta-orchestrator workflows that oversee, coordinate, and optimize the agent ecosystem. These "managerial agents" operate at a higher level than regular workflows, monitoring and managing multiple agents to ensure overall system health and effectiveness. +The hierarchical agent system consists of specialized meta-orchestrator workflows that oversee, coordinate, and optimize the agent ecosystem. These meta-orchestrator agents operate at a higher level than regular workflows, monitoring and managing multiple agents to ensure overall system health and effectiveness. ## Meta-Orchestrator Agents @@ -54,7 +54,7 @@ The hierarchical agent system consists of specialized meta-orchestrator workflow **Schedule:** Daily **Key Capabilities:** -- Comprehensive health monitoring +- System-wide health monitoring (compilation status, execution rates, error patterns) - Systemic issue detection - Dependency mapping - Performance optimization @@ -193,7 +193,7 @@ Meta-orchestrators take action through safe outputs: ### Reporting -Meta-orchestrators provide comprehensive reports: +Meta-orchestrators provide detailed reports including: - Executive summaries for high-level overview - Detailed findings for investigation - Actionable recommendations for improvement @@ -294,7 +294,7 @@ Meta-orchestrators provide comprehensive reports: Potential improvements to the hierarchical system: -1. **Automated Remediation:** Meta-orchestrators could automatically fix simple issues +1. **Automated Remediation:** Meta-orchestrators could automatically fix issues such as outdated dependencies, formatting violations, and broken links 2. **Predictive Analytics:** Use ML to predict failures before they occur 3. **Self-Optimization:** Meta-orchestrators could tune their own parameters 4. **Cross-Repository Management:** Extend to manage agents across multiple repos diff --git a/specs/gastown.md b/specs/gastown.md index 655cbce7fd..a249469eb1 100644 --- a/specs/gastown.md +++ b/specs/gastown.md @@ -955,7 +955,7 @@ Gastown provides a mature, battle-tested architecture for multi-agent coordinati 4. **Workflow Composition**: Support template inheritance and aspect-oriented programming 5. **Progress Monitoring**: Real-time dashboards and health checks for multi-workflow campaigns -These enhancements would position gh-aw as a comprehensive agentic workflow platform capable of both simple automation and complex multi-agent coordination, while maintaining its security-first approach and GitHub-native integration. +These enhancements would position gh-aw as a full-featured agentic workflow platform capable of both basic automation and complex multi-agent coordination, while maintaining its security-first approach and GitHub-native integration. --- diff --git a/specs/go-type-patterns.md b/specs/go-type-patterns.md index 8cd61a7978..9673824c94 100644 --- a/specs/go-type-patterns.md +++ b/specs/go-type-patterns.md @@ -222,7 +222,7 @@ const SafeInputsFeatureFlag = "safe-inputs" **Benefits**: - Single source of truth for feature flag names - Prevents typos when checking feature flags -- Easy to find all usages through IDE navigation +- Supports IDE navigation to find all usages #### Tool Configuration Types @@ -620,7 +620,7 @@ type CodingAgentEngine interface { **Benefits**: - Multiple engine implementations (Copilot, Claude, Codex) -- Easy to add new engines +- New engines can be added by implementing the Engine interface - Testable with mock implementations - Clear contract for engine behavior @@ -818,7 +818,7 @@ func ProcessConfig(config Config) error { **Problem**: Primitive types don't convey meaning and enable mistakes ```go -// ❌ BAD - Easy to mix up timeout and retry count +// ❌ BAD - Callers may confuse timeout and retry count func CallAPI(url string, timeout int, retries int) error { // Which int is which? CallAPI("https://api.example.com", 3, 5) // Wrong order! diff --git a/specs/labels.md b/specs/labels.md index 9c589db3f3..271c508493 100644 --- a/specs/labels.md +++ b/specs/labels.md @@ -125,7 +125,7 @@ Analysis of the repository (as of December 2024) shows: - **Issues with `plan`**: 16 (45.7%) - **Issues with `ai-generated`**: 16 (45.7%) - **Perfect overlap**: All `plan` issues also have `ai-generated` -- **Unlabeled issues**: 0 (excellent!) +- **Unlabeled issues**: 0 (100% labeled) ### Key Findings diff --git a/specs/mdflow.md b/specs/mdflow.md index 37caae1c56..478db0291d 100644 --- a/specs/mdflow.md +++ b/specs/mdflow.md @@ -227,7 +227,7 @@ gh aw run workflow.md --local --staged #### 3. **Transparent Mapping** - Frontmatter keys directly become CLI flags (no magic) -- Easy to understand: `model: opus` → `--model opus` +- Direct mapping: `model: opus` → `--model opus` - Debugging is straightforward: `mdflow explain task.claude.md` **Lesson for gh-aw**: Add `gh aw explain` command: @@ -439,7 +439,7 @@ network: --- ``` -**Impact**: Steep learning curve for simple tasks. +**Impact**: Requires understanding frontmatter, safe outputs, and GitHub Actions for basic automation. #### 2. **GitHub-Only** - Cannot run outside GitHub Actions @@ -792,7 +792,7 @@ gh aw compile #### 2. **Enhanced MCP Ecosystem** - MCP server registry -- Easy discovery and installation +- Registry-based discovery and installation - Shared configurations **Inspiration**: mdflow's MCP server patterns. diff --git a/specs/mods/jsonschema-go.md b/specs/mods/jsonschema-go.md index 11f0cbcfbc..c3f06cef0a 100644 --- a/specs/mods/jsonschema-go.md +++ b/specs/mods/jsonschema-go.md @@ -109,7 +109,7 @@ tool := &mcp.Tool{ - Comprehensive error reporting 4. **Developer-Friendly API** - - Simple, intuitive function signatures + - Concise function signatures following Go idioms - Good integration with Go idioms - Clear documentation and examples @@ -181,7 +181,7 @@ While not officially released, upstream development suggests: - ✅ Clear error messages for schema generation failures 3. **Type Safety** - - ✅ Excellent use of generics for compile-time safety + - ✅ Uses generics for compile-time type safety - ✅ No runtime type assertions needed - 💡 Could extend pattern to other schema operations diff --git a/specs/oh-my-code.md b/specs/oh-my-code.md index a957fd5cdd..f926d05db3 100644 --- a/specs/oh-my-code.md +++ b/specs/oh-my-code.md @@ -695,7 +695,7 @@ inputs: **Benefits of Stateless Model**: - Predictable, reproducible runs -- Easy to reason about (no hidden state) +- Transparent behavior (no hidden state) - Scales horizontally (parallel runs) - Audit trail via GitHub Actions logs @@ -1048,7 +1048,7 @@ gh aw mcp inspect issue-responder **Scalability**: - **Horizontal**: Run multiple OpenCode instances (different projects) -- **Vertical**: More powerful machine = more background agents +- **Vertical**: Higher-spec machine (more CPU/RAM) = more background agents - **Cost**: Pay for LLM API usage only (no CI/CD minutes) **Optimization Tips**: @@ -1640,7 +1640,7 @@ oh-my-opencode and GitHub Agentic Workflows represent two complementary approach - Repository-wide coordination **Neither replaces the other** - they solve different problems in different contexts: -- Use **oh-my-opencode** when you need powerful local development with AI agents as teammates +- Use **oh-my-opencode** when you need full-featured local development with AI agents as teammates - Use **gh-aw** when you need secure, auditable automation for team/org workflows **Together, they provide a comprehensive AI-powered development stack**: diff --git a/specs/testing.md b/specs/testing.md index cc6fd7bc36..f61a6ecafe 100644 --- a/specs/testing.md +++ b/specs/testing.md @@ -158,9 +158,9 @@ This project **intentionally avoids** mocking frameworks and test suites: - **Parallel execution**: Standard Go tests run in parallel efficiently - **Simplicity**: No suite lifecycle methods to understand - **Explicitness**: Setup is visible in each test -- **Compatibility**: Works seamlessly with `go test` tooling +- **Compatibility**: Compatible with standard `go test` tooling -This approach keeps tests simple, fast, and maintainable. Tests verify real component interactions rather than mocked behavior. +This approach keeps tests focused, fast, and maintainable. Tests verify real component interactions rather than mocked behavior. ### Running Tests