Skip to content

[docs] Consolidate developer specs: fix 3 tone issues, bump dev.md to v3.5 #19472

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
pelikhan merged 2 commits into from
Mar 4, 2026
+5 −5
Merged

[docs] Consolidate developer specs: fix 3 tone issues, bump dev.md to v3.5 #19472

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
95ae9db
docs: fix 3 minor marketing-tone phrases in spec files (v3.5)
Mar 4, 2026
3bd0198
ci: trigger checks
github-actions[bot] Mar 4, 2026
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
4 changes: 2 additions & 2 deletions scratchpad/dev.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
2 changes: 1 addition & 1 deletion scratchpad/engine-review-summary.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Copy link

Copilot AI Mar 4, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The replacement phrase "Consistent, well-documented for straightforward implementation" is grammatically awkward and unclear. The construction "well-documented for straightforward implementation" is ambiguous — it is not clear what is well-documented, nor what "for straightforward implementation" modifies. The original point (item 5 in the list) was describing that the code patterns are easy to understand and follow, meaning they are legible and consistent. A clearer replacement that avoids both the marketing tone and the awkward grammar would be something like: "Consistent, well-documented patterns that enable straightforward implementation."

Suggested change
5. **Clear Patterns**: Consistent, well-documented for straightforward implementation
5. **Clear Patterns**: Consistent, well-documented patterns that enable straightforward implementation

Copilot uses AI. Check for mistakes.

The architecture **requires no structural changes**. The only gap was comprehensive documentation for adding new engines, which has been addressed with:

Expand Down
4 changes: 2 additions & 2 deletions scratchpad/guard-policies-specification.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

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