From caf7cd68abe5be133fee86e2b94aa2a6cc46d443 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Sat, 11 Apr 2026 11:11:46 +0000 Subject: [PATCH] docs: tone fixes in engine review specs (v5.8) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Remove promotional star ratings from engine-review-summary.md and engine-architecture-review.md. These ⭐⭐⭐⭐⭐ (5/5) ratings were present in freshly-added files and reverted previous fixes from v4.9. - engine-review-summary.md (6 fixes): remove star ratings from section headings (Strengths, Interface Design, Security, Testing, Documentation), remove Rating column from Implementation Quality table - engine-architecture-review.md (3 fixes): remove Rating lines from Copilot, Claude, Codex/Custom engine sections Bumps dev.md to v5.8. Co-Authored-By: Claude Sonnet 4.6 --- scratchpad/dev.md | 5 +++-- scratchpad/engine-architecture-review.md | 8 -------- scratchpad/engine-review-summary.md | 22 +++++++++++----------- 3 files changed, 14 insertions(+), 21 deletions(-) diff --git a/scratchpad/dev.md b/scratchpad/dev.md index db9aad3729c..a607d1e8480 100644 --- a/scratchpad/dev.md +++ b/scratchpad/dev.md @@ -1,7 +1,7 @@ # Developer Instructions -**Version**: 5.7 -**Last Updated**: 2026-04-10 +**Version**: 5.8 +**Last Updated**: 2026-04-11 **Purpose**: Consolidated development guidelines for GitHub Agentic Workflows This document consolidates specifications from the scratchpad directory into unified developer instructions. It provides architecture patterns, security guidelines, code organization rules, and testing practices. @@ -2795,6 +2795,7 @@ These files are loaded automatically by compatible AI tools (e.g., GitHub Copilo --- **Document History**: +- v5.8 (2026-04-11): Maintenance tone scan — fixed 9 tone issues across 2 spec files: `engine-review-summary.md` (6 fixes: `### Strengths ⭐⭐⭐⭐⭐`→`### Strengths`, `### Interface Design: ⭐⭐⭐⭐⭐ (5/5)`→`### Interface Design`, removed Rating column from Implementation Quality table and replaced "Comprehensive single-file implementation" with "Single-file implementation", `### Security: ⭐⭐⭐⭐⭐ (5/5)`→`### Security`, `### Testing: ⭐⭐⭐⭐⭐ (5/5)`→`### Testing`, `### Documentation: ⭐⭐⭐⭐⭐ (5/5) - After Improvements`→`### Documentation - After Improvements`), `engine-architecture-review.md` (3 fixes: removed 3 `**Rating**: ⭐⭐⭐⭐⭐ (5/5)` lines from Copilot, Claude, Codex, and Custom engine sections). Coverage: 75 spec files (no new files). - v5.7 (2026-04-10): Maintenance tone scan — fixed 4 tone issues across 2 spec files: `oh-my-code.md` (3 fixes: "Deep Research Comparison"→"Technical Comparison", "Comprehensive Analysis"→"Analysis", "deep research comparison between"→"compares"), `mdflow-comparison.md` (1 fix: "detailed syntax comparison"→"syntax comparison"). Updated Related Documentation description for `oh-my-code.md`. Coverage: 75 spec files (no new files). - v5.6 (2026-04-09): Fixed 4 broken links in `scratchpad/README.md` (case-sensitive file name corrections: `MCP_LOGS_GUARDRAIL.md`→`mcp_logs_guardrails.md`, `SCHEMA_VALIDATION.md`→`schema-validation.md`, `SECURITY_REVIEW_TEMPLATE_INJECTION.md`→`security_review.md`; `campaigns-files.md` marked removed). Fixed 3 tone issues in `README.md` ("Detailed comparison"→"Comparison", "Detailed analysis"→"Analysis", "Complete deep-dive statistical analysis"→"Statistical analysis"). Updated `README.md` last-updated date. Added `README.md` to Related Documentation. Coverage: 75 spec files (no new files). - v5.5 (2026-04-08): Added WorkQueueOps and BatchOps design pattern subsections to Workflow Patterns (from PR #25178: four queue strategies — issue checklist, sub-issues, cache-memory, discussion-based; four batch strategies — chunked, matrix fan-out, rate-limit-aware, result aggregation). Added 2 new Related Documentation links for `docs/src/content/docs/patterns/workqueue-ops.md` and `batch-ops.md`. Coverage: 75 spec files (2 new pattern docs). diff --git a/scratchpad/engine-architecture-review.md b/scratchpad/engine-architecture-review.md index 254ed1cf277..798ca23db08 100644 --- a/scratchpad/engine-architecture-review.md +++ b/scratchpad/engine-architecture-review.md @@ -87,8 +87,6 @@ Key helper functions in `engine_helpers.go`: **Areas for improvement**: - None identified -**Rating**: ⭐⭐⭐⭐⭐ (5/5) - ### Claude Engine **File**: claude_engine.go (474 lines) @@ -102,8 +100,6 @@ Key helper functions in `engine_helpers.go`: **Areas for improvement**: - None identified -**Rating**: ⭐⭐⭐⭐⭐ (5/5) - ### Codex Engine **Files**: 3 files (codex_engine.go, codex_mcp.go, codex_logs.go) @@ -116,8 +112,6 @@ Key helper functions in `engine_helpers.go`: **Areas for improvement**: - None identified -**Rating**: ⭐⭐⭐⭐⭐ (5/5) - ### Custom Engine **File**: custom_engine.go (373 lines) @@ -130,8 +124,6 @@ Key helper functions in `engine_helpers.go`: **Areas for improvement**: - None identified -**Rating**: ⭐⭐⭐⭐⭐ (5/5) - ## Extensibility Assessment ### Adding New Engines diff --git a/scratchpad/engine-review-summary.md b/scratchpad/engine-review-summary.md index bed7dfdab31..ca0129b6346 100644 --- a/scratchpad/engine-review-summary.md +++ b/scratchpad/engine-review-summary.md @@ -31,7 +31,7 @@ Completed comprehensive deep review of the agentic engine architecture, interfac ## Key Findings -### Strengths ⭐⭐⭐⭐⭐ +### Strengths 1. **Interface Segregation Principle (ISP) Implementation** - 7 focused interfaces compose into 1 composite @@ -89,7 +89,7 @@ Completed comprehensive deep review of the agentic engine architecture, interfac ## Architecture Assessment -### Interface Design: ⭐⭐⭐⭐⭐ (5/5) +### Interface Design The interface hierarchy follows the Interface Segregation Principle: @@ -131,30 +131,30 @@ CodingAgentEngine (composite - backward compatibility) ### Implementation Quality -| Engine | Files | Rating | Notes | -|--------|-------|--------|-------| -| Copilot | 7 | ⭐⭐⭐⭐⭐ | Modular organization (7 files) | -| Claude | 1 | ⭐⭐⭐⭐⭐ | Comprehensive single-file implementation | -| Codex | 3 | ⭐⭐⭐⭐⭐ | TOML config, 3-file structure | -| Custom | 1 | ⭐⭐⭐⭐⭐ | Simple, focused | +| Engine | Files | Notes | +|--------|-------|-------| +| Copilot | 7 | Modular organization (7 files) | +| Claude | 1 | Single-file implementation | +| Codex | 3 | TOML config, 3-file structure | +| Custom | 1 | Simple, focused | All implementations follow established patterns and are thoroughly tested. -### Security: ⭐⭐⭐⭐⭐ (5/5) +### Security - Proper secret declaration and validation - Environment variable filtering - Safe-inputs integration - Firewall support (Copilot, Claude, Codex) -### Testing: ⭐⭐⭐⭐⭐ (5/5) +### Testing - Automated interface compliance (`TestInterfaceSegregation`) - Engine-specific unit tests - Integration tests for compilation - All tests passing -### Documentation: ⭐⭐⭐⭐⭐ (5/5) - After Improvements +### Documentation - After Improvements **Before**: Reference docs good, developer guide missing **After**: Complete developer documentation added