Skip to content

[caveman] Optimize instruction verbosity — visual-regression, workflow-constraints, workflow-editing, workflow-patterns, adr-wri [Content truncated due to length]#39285

Merged
pelikhan merged 1 commit into
mainfrom
caveman/2026-06-14-725f8dbdb9bd5832
Jun 14, 2026

Conversation

@github-actions

@github-actions github-actions Bot commented Jun 14, 2026

Copy link
Copy Markdown
Contributor

Trim instruction prose in 5 AW files

Summary

Pure prose-trimming pass across five agent-workflow instruction/documentation files. Verbosity is reduced throughout — via shorter bullet points, tighter inline descriptions, and renamed section headers — while preserving all substantive guidance, YAML schema hints, field examples, and compiler constraints. No functional or behavioral changes; no Go source, schemas, or generated files are touched.


Changes by file

File Change type Description
.github/agents/adr-writer.agent.md Modified Condensed prose throughout — trimmed bullet wording, removed introductory labels (e.g. Key principles:), tightened inline descriptions. No guidance removed.
.github/aw/visual-regression.md Modified Shortened bullets in "Key Design Decisions" and "Network-Minimization Reminders" by cutting redundant words and explanatory clauses.
.github/aw/workflow-constraints.md Modified Renamed section headers to shorter imperative forms (e.g. What They Can DoCan Do), trimmed constraint-list prose, condensed suggested-response-pattern text.
.github/aw/workflow-editing.md Modified Condensed verbose phrasing in headings, bullet points, and rule descriptions with no alteration to technical guidance.
.github/aw/workflow-patterns.md Modified Shortened all pattern descriptions and bullets across every pattern section; no structural or guidance changes.

Impact

Attribute Value
Breaking changes None
Functional impact None — all YAML hints, field examples, and compiler constraints preserved verbatim
Affected surface Agent prompt context windows (smaller per-prompt token footprint)
Severity Low–Medium (adr-writer.agent.md and workflow-constraints.md rated medium due to section-header renames)

Notes

  • The section-header renames in workflow-constraints.md (e.g. What They Can DoCan Do) are the only structural changes; verify no tooling or tests match these header strings literally.
  • All changes are documentation-only — no Go source, schemas, or generated files were modified.

Generated by PR Description Updater for issue #39285 · 175.1 AIC · ⌖ 13 AIC · ⊞ 20.9K ·

Apply caveman optimization principle to reduce verbosity while
preserving all YAML schema hints, field examples, and compiler
constraints.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@github-actions github-actions Bot added automation documentation Improvements or additions to documentation prompt-quality labels Jun 14, 2026
@github-actions

Copy link
Copy Markdown
Contributor Author

Hey @github-actions 👋 — thanks for this caveman optimization run! The verbosity reduction across visual-regression.md, workflow-constraints.md, workflow-editing.md, workflow-patterns.md, and adr-writer.agent.md is well-structured, and the PR description is excellent — the before/after table and the explicit list of what was preserved (YAML fields, schema constraints, security rules) make it easy to review with confidence.

One note for the team reviewing this bot-generated PR:

  • No test coverage — there are no automated checks verifying that the compressed instruction text still produces correct agent behavior. For pure markdown edits this is often unavoidable, but if the project has any prompt-regression or output-comparison tests for these instruction files, it would be worth running them before merging.

If you’d like a hand adding a smoke-test layer for instruction file changes, you can assign this prompt to your coding agent:

Add a lightweight regression test for the instruction files modified in this PR:
  - .github/aw/visual-regression.md
  - .github/aw/workflow-constraints.md
  - .github/aw/workflow-editing.md
  - .github/aw/workflow-patterns.md
  - .github/agents/adr-writer.agent.md

The test should:
1. Parse each file and assert that all required YAML fields, section headings, and security-rule keywords defined in the project’s schema are still present after optimization.
2. Fail if any known-required keyword (e.g. ‘safe-outputs’, ‘permissions’, trigger patterns) has been removed.
3. Be placed in the existing test directory structure used by this project.

Generated by ✅ Contribution Check · 455.7 AIC · ⌖ 13.3 AIC · ⊞ 24.7K ·

@pelikhan pelikhan merged commit ebeda50 into main Jun 14, 2026
@pelikhan pelikhan deleted the caveman/2026-06-14-725f8dbdb9bd5832 branch June 14, 2026 21:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

automation documentation Improvements or additions to documentation prompt-quality

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant