Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions scratchpad/dev.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down Expand Up @@ -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).
Expand Down
8 changes: 0 additions & 8 deletions scratchpad/engine-architecture-review.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand All @@ -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)
Expand All @@ -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)
Expand All @@ -130,8 +124,6 @@ Key helper functions in `engine_helpers.go`:
**Areas for improvement**:
- None identified

**Rating**: ⭐⭐⭐⭐⭐ (5/5)

## Extensibility Assessment

### Adding New Engines
Expand Down
22 changes: 11 additions & 11 deletions scratchpad/engine-review-summary.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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:

Expand Down Expand Up @@ -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
Expand Down