From f4138059ae53f1abdf2219bea7e855b5ec8b6ce6 Mon Sep 17 00:00:00 2001 From: gh-aw bot Date: Fri, 6 Mar 2026 00:10:34 +0000 Subject: [PATCH 1/2] docs: fix 3 tone issues in scratchpad specs (v3.7) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Remove subjective adjectives and promotional language from specification files as part of daily documentation consolidation review (2026-03-06). Changes: - guard-policies-specification.md:17 — remove "intuitive way" - guard-policies-specification.md:303 — replace "User-friendly: Intuitive frontmatter syntax" with "Consistent syntax: Follows existing frontmatter conventions" - engine-architecture-review.md:312 — replace "significantly improves the developer experience" with precise technical description - dev.md — bump to v3.7, add history entry Co-Authored-By: Claude Sonnet 4.6 --- scratchpad/dev.md | 5 +++-- scratchpad/engine-architecture-review.md | 2 +- scratchpad/guard-policies-specification.md | 4 ++-- 3 files changed, 6 insertions(+), 5 deletions(-) diff --git a/scratchpad/dev.md b/scratchpad/dev.md index e2db5a1571f..d6a2afe0f47 100644 --- a/scratchpad/dev.md +++ b/scratchpad/dev.md @@ -1,7 +1,7 @@ # Developer Instructions -**Version**: 3.6 -**Last Updated**: 2026-03-05 +**Version**: 3.7 +**Last Updated**: 2026-03-06 **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. @@ -2120,6 +2120,7 @@ These files are loaded automatically by compatible AI tools (e.g., GitHub Copilo --- **Document History**: +- v3.7 (2026-03-06): Fixed 3 tone issues — removed "intuitive way" (guard-policies-specification.md:17), replaced "User-friendly: Intuitive frontmatter syntax" with "Consistent syntax: Follows existing frontmatter conventions" (guard-policies-specification.md:303), and replaced "significantly improves the developer experience" with precise language (engine-architecture-review.md:312). Coverage: 63 spec files (62 spec + 1 test artifact). - v3.6 (2026-03-05): Fixed 2 tone issues — removed "seamlessly" from guard-policies-specification.md:307 and "robust" from pr-checkout-logic-explained.md:56. Coverage: 63 spec files (62 spec + 1 test artifact). - v3.5 (2026-03-04): Fixed 3 tone issues — "Easy to add policies" → "Supports adding policies" (guard-policies-specification.md:286), "Easy to add new servers" → "New servers and policy types can be added without structural changes" (guard-policies-specification.md:302), "Easy to understand and follow" → "Consistent, well-documented for straightforward implementation" (engine-review-summary.md:282). Coverage: 63 spec files (62 spec + 1 test artifact). - v3.4 (2026-03-01): Added Package Structure section to Core Architecture (from `architecture.md`, updated 2026-03-01); added GitHub MCP Guard Policies section to MCP Integration (from `guard-policies-specification.md`); added 2 new Related Documentation links. Coverage: 63 spec files (62 spec + 1 test artifact). diff --git a/scratchpad/engine-architecture-review.md b/scratchpad/engine-architecture-review.md index 2af70609a88..758143a8704 100644 --- a/scratchpad/engine-architecture-review.md +++ b/scratchpad/engine-architecture-review.md @@ -309,7 +309,7 @@ Engine code includes: The agentic engine architecture follows ISP, implements security at multiple layers, and is structured for extension. The Interface Segregation Principle implementation provides flexibility while maintaining backward compatibility. All current implementations follow established patterns and are thoroughly tested. -The addition of comprehensive documentation (`adding-new-engines.md`) significantly improves the developer experience for adding new engines. The architecture requires no structural changes and is ready to support additional integrations. +The `adding-new-engines.md` document provides step-by-step guidance for implementing new engines. The architecture requires no structural changes and supports additional integrations. ### Overall Rating diff --git a/scratchpad/guard-policies-specification.md b/scratchpad/guard-policies-specification.md index dda8a622f9e..86ffbe795ee 100644 --- a/scratchpad/guard-policies-specification.md +++ b/scratchpad/guard-policies-specification.md @@ -14,7 +14,7 @@ The user requested support for guard policies in the MCP gateway configuration, 2. Design an extensible system that can support future MCP servers (Jira, WorkIQ) with different policy schemas -3. Expose these parameters through workflow frontmatter in an intuitive way +3. Expose these parameters through workflow frontmatter fields ## Proposed Solution @@ -300,7 +300,7 @@ This implementation provides a solid foundation for guard policies in the MCP ga - **Type-safe**: Strongly-typed structs with validation - **Extensible**: New servers and policy types can be added without structural changes -- **User-friendly**: Intuitive frontmatter syntax +- **Consistent syntax**: Follows existing frontmatter conventions - **Well-validated**: Comprehensive validation with clear error messages - **Forward-compatible**: Supports future enhancements From 93831127e5b73c3ca66cdb6f1d992fdc598c97fb Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" Date: Fri, 6 Mar 2026 00:12:26 +0000 Subject: [PATCH 2/2] ci: trigger checks