Skip to content

[docs] Consolidate developer specs — v4.4 (2026-03-27) #23219

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 1 commit into from
Mar 27, 2026
Merged

[docs] Consolidate developer specs — v4.4 (2026-03-27) #23219

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 4 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**: 4.3
**Last Updated**: 2026-03-25
**Version**: 4.4
**Last Updated**: 2026-03-27
Copy link
Copy Markdown
Contributor Author

@github-actions github-actions bot Mar 27, 2026

Choose a reason for hiding this comment

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

✅ Version bump from 4.3 → 4.4 and date update look correct. [Smoke test automated review - Run 23646156582]

**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 @@ -2542,6 +2542,7 @@ These files are loaded automatically by compatible AI tools (e.g., GitHub Copilo
- [Testing Guidelines](./testing.md) - Testing framework: assert vs require, fuzz tests, security regression tests, benchmarks, and `make` test commands
- [Token Budget Guidelines](./token-budget-guidelines.md) - Token budget targets and optimization strategies: `max-turns` engine restrictions (Claude/Custom only), `timeout-minutes` configuration, and prompt optimization patterns for Copilot workflows
- [Custom GitHub Actions Build System](./actions.md) - Custom Go-based actions build system: directory structure (`actions/`), build tooling (`pkg/cli/actions_build_command.go`), action modes (standard vs dev), and CI integration
- [Daily Reports Metrics Glossary](./metrics-glossary.md) - Standardized metric names and scopes for daily report workflows: issue, PR, workflow, firewall, code quality, observability, and Copilot agent metrics; cross-report comparison guidelines

### External References

Copy link
Copy Markdown
Contributor Author

@github-actions github-actions bot Mar 27, 2026

Choose a reason for hiding this comment

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

✅ The metrics-glossary.md link addition is well-structured and consistent with existing related documentation entries. [Smoke test automated review - Run 23646156582]

Expand All @@ -2553,6 +2554,7 @@ These files are loaded automatically by compatible AI tools (e.g., GitHub Copilo
---

**Document History**:
- v4.4 (2026-03-27): Added Related Documentation link for `metrics-glossary.md` (standardized metric names and scopes for daily report workflows: issue, PR, workflow, firewall, code quality, observability, Copilot agent metrics; cross-report comparison guidelines). Maintenance tone scan: 0 new issues. Coverage: 62 spec files.
- v4.3 (2026-03-25): Updated `guard-policies-specification.md` to use `allowed-repos` instead of deprecated `repos` field throughout (added migration note: `repos` is a deprecated alias, `gh aw fix` migrates automatically). No new spec files; no tone issues. Coverage: 62 spec files.
- v4.2 (2026-03-24): Added engine-specific capability notes to Engine Interface Architecture section (`max-turns` is Claude/Custom only, not Copilot; `firewall` support matrix). Added Related Documentation links for `token-budget-guidelines.md` (max-turns restrictions, timeout-minutes config, Copilot prompt optimization) and `actions.md` (custom Go-based actions build system). Coverage: 62 spec files.
- v4.1 (2026-03-22): Updated `repos` → `allowed-repos` in GitHub MCP Guard Policies section (reflects PR #22331 codemod; `repos` is now a deprecated alias). Added deprecation migration note (`gh aw fix`). Added Related Documentation link for GitHub MCP Access Control Specification. Coverage: 66 spec files.
Expand Down