diff --git a/scratchpad/dev.md b/scratchpad/dev.md index 9a16e12a7a..990f3394b8 100644 --- a/scratchpad/dev.md +++ b/scratchpad/dev.md @@ -1,7 +1,7 @@ # Developer Instructions -**Version**: 3.4 -**Last Updated**: 2026-03-01 +**Version**: 3.5 +**Last Updated**: 2026-03-04 **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. diff --git a/scratchpad/engine-review-summary.md b/scratchpad/engine-review-summary.md index 08414108e5..23cf908949 100644 --- a/scratchpad/engine-review-summary.md +++ b/scratchpad/engine-review-summary.md @@ -279,7 +279,7 @@ The agentic engine architecture is **production-ready**. It follows SOLID princi 2. **BaseEngine Defaults**: Sensible defaults for all methods 3. **Shared Helpers**: Reduce duplication and ensure consistency 4. **Comprehensive Testing**: Automated validation of compliance -5. **Clear Patterns**: Easy to understand and follow +5. **Clear Patterns**: Consistent, well-documented for straightforward implementation The architecture **requires no structural changes**. The only gap was comprehensive documentation for adding new engines, which has been addressed with: diff --git a/scratchpad/guard-policies-specification.md b/scratchpad/guard-policies-specification.md index f44e18e341..7e93b6050d 100644 --- a/scratchpad/guard-policies-specification.md +++ b/scratchpad/guard-policies-specification.md @@ -283,7 +283,7 @@ tools: 1. **Security**: Restrict AI agent access to specific repositories 2. **Compliance**: Enforce minimum min-integrity requirements 3. **Flexibility**: Support diverse repository patterns and wildcards -4. **Extensibility**: Easy to add policies for Jira, WorkIQ, etc. +4. **Extensibility**: Supports adding policies for Jira, WorkIQ, etc. 5. **Clarity**: Clear error messages and validation 6. **Documentation**: Self-documenting through type system @@ -299,7 +299,7 @@ tools: This implementation provides a solid foundation for guard policies in the MCP gateway. The design is: - **Type-safe**: Strongly-typed structs with validation -- **Extensible**: Easy to add new servers and policy types +- **Extensible**: New servers and policy types can be added without structural changes - **User-friendly**: Intuitive frontmatter syntax - **Well-validated**: Comprehensive validation with clear error messages - **Forward-compatible**: Supports future enhancements