Thanks to visit codestin.com
Credit goes to github.com

Skip to content

feat(git-commit-push-pr): add conditional visual aids to PR descriptions#444

Merged
tmchow merged 4 commits into
mainfrom
feat/pr-visual-aids
Mar 29, 2026
Merged

feat(git-commit-push-pr): add conditional visual aids to PR descriptions#444
tmchow merged 4 commits into
mainfrom
feat/pr-visual-aids

Conversation

@tmchow
Copy link
Copy Markdown
Collaborator

@tmchow tmchow commented Mar 29, 2026

Summary

Adds a #### Visual communication subsection to git-commit-push-pr's Step 6, completing the visual aids trilogy across the plugin's document-generating skills. Complex PRs with architectural changes, workflow modifications, or multi-component interactions can now include mermaid diagrams, ASCII art, or comparison tables in their descriptions -- when the content warrants it.

This follows the same content-pattern-based conditional approach established in ce:brainstorm (#437) and ce:plan (#440), adapted for the PR description surface where reviewers scan quickly rather than study deeply.

Key decisions

  • Higher trigger bar than sibling skills: PR descriptions are scanned, not studied. Triggers fire on architectural changes touching 3+ components, workflow/pipeline changes with non-obvious sequencing, mode/state introductions, and data model relationship changes -- not on PR size or line count.
  • Smaller diagrams: 5-10 nodes typical (vs 5-15 in brainstorm/plan), up to 15 only for genuinely complex changes.
  • Explicit skip for small changes: The sizing table already routes small/simple changes to brief descriptions. The skip criteria reinforce that these never get diagrams.
  • Self-contained format selection: Mermaid (TB direction, text-fallback-friendly), ASCII (80-column max, annotation-dense flows), and markdown tables -- all restated with PR-appropriate calibration rather than cross-referencing sibling skills.

Also included

  • Implementation plan: docs/plans/2026-03-29-003-feat-pr-description-visual-aids-plan.md
  • Compound learning: docs/solutions/best-practices/conditional-visual-aids-in-generated-documents-2026-03-29.md -- comprehensive reference covering the conditional visual aid pattern across all three skills, including decision framework for format selection, surface-specific calibration, cross-device layout optimization, and prevention checklist.

Test plan

  • 527 tests pass (full suite, bun test)
  • Existing "Markdown tables for data" writing principle at line 280 unchanged
  • DU-3 inherits the new guidance through its existing "following the writing principles in Step 6" reference -- no changes to the description-update workflow
  • Steps 1-5, 7-8 untouched (state machine structure preserved per docs/solutions/skill-design/git-workflow-skills-need-explicit-state-machines-2026-03-27.md)

Compound Engineering v2.59.0
🤖 Generated with Claude Opus 4.6 (1M context, extended thinking) via Claude Code

tmchow added 3 commits March 29, 2026 14:00
Add a Visual communication subsection to Step 6 with content-pattern-based
triggers for including mermaid diagrams, ASCII art, and comparison tables
in PR descriptions. Follows the same conditional approach as ce:brainstorm
(#437) and ce:plan (#440), calibrated for the PR scanning context with a
higher trigger bar and smaller diagrams (5-10 nodes typical).
Copy link
Copy Markdown

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: a966a04147

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread plugins/compound-engineering/skills/git-commit-push-pr/SKILL.md Outdated
…ges only

Remove "3-5 sentences" from the blanket skip criterion so that
small-but-structurally-complex changes can still receive visual aids
when content patterns warrant it. Resolves contradiction with the
content-pattern-based inclusion principle.

Co-Authored-By: Claude Opus 4.6 (1M context) <[email protected]>
@tmchow tmchow merged commit 44e3e77 into main Mar 29, 2026
2 checks passed
@github-actions github-actions Bot mentioned this pull request Mar 29, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant