Skip to content

feat(planning): add a design-principles reference cited to canonical sources - #8393

Merged
kyle-sexton merged 3 commits into
mainfrom
feat/8332-design-principles-reference
Oct 19, 2026
Merged

kyle-sexton merged 3 commits into
mainfrom
feat/8332-design-principles-reference

Conversation

@kyle-sexton

Copy link
Copy Markdown
Member

Closes #8332

Summary

Adds plugins/planning/reference/design-principles.md, a bundled reference of foundational design principles that planning and implementation skills can read at design time. Each principle is one directive line cited to its defining canonical source, with an as-of date and a recheck trigger. Review-time checking of the same concerns stays with /review:quality-gate code-design, which the reference points at.

Fix

  • New plugins/planning/reference/design-principles.md: SOLID, composition over inheritance, DRY of knowledge, coupling and cohesion, information hiding, deep modules, YAGNI's cheap-now test and reuse first. It applies to code, Markdown, skills and agent instructions, and a consumer's own standards override it.
  • Sources are universal canonical primaries only; no org's own standards files are cited. Three secondaries appear, each labeled, where a book primary cannot be fetched.
  • Changelog fragment under .changes/planning/ (minor bump).

Verification

Related

🤖 Generated with Claude Code

kyle-sexton and others added 3 commits October 18, 2026 23:24
One directive line per foundational principle (SRP, OCP, LSP, ISP, DIP,
composition over inheritance, DRY of knowledge, coupling and cohesion,
information hiding, deep modules and change amplification, YAGNI's
cheap-now test, reuse first), each cited to its defining source with an
as-of date and a recheck trigger. It opens with the scope line and the
consumer-wins override line, and points at /review:quality-gate
code-design for review-time criteria.

Refs: #8332

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
… design principles

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@kyle-sexton
kyle-sexton marked this pull request as ready for review October 19, 2026 05:11
@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Oct 19, 2026 •

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-10-19T05:12:28.113435Z f6b964b Draft marked ready
ℹ️ 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" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@github-actions

Copy link
Copy Markdown
Contributor

claude-security-review reviewed f6b964be843048ca5c055e0921d31abdb51df09d: 0 finding(s), 0 as inline comments.

No security issues found in PR #8393 at head f6b964b.

The PR adds two files: a changelog fragment and plugins/planning/reference/design-principles.md. Both are documentation only. The diff has no executable code, workflow, hook, permission or config change, and no secrets or credentials.

The diff deletes, narrows or softens no standing instruction, so the instruction-surface lens found nothing to check against the exception register.

The new reference tells agents to apply a consumer's own standards over its defaults and to record the override. That is guidance for design-time defaults. It does not weaken any guardrail, and it gives no way to bypass a hook, a permission rule or a validator.

The external links are citations only. The file instructs no fetching and runs nothing from them.

@github-actions

Copy link
Copy Markdown
Contributor

claude-review reviewed f6b964be843048ca5c055e0921d31abdb51df09d: 0 finding(s), 0 as inline comments.

No findings. I reviewed both changed files: the new plugins/planning/reference/design-principles.md and the changelog fragment.

Checked against #8332's acceptance criteria. I ran these checks myself:

  • grep -c "melodic-software/standards" on the reference returns 0.
  • grep -cE "^- \*\*(SRP|OCP|LSP|ISP|DIP)\*\*" returns 5.
  • grep -c "; recheck when" returns 12, which meets the ≥ 11 requirement.
  • The link target variation-points.md exists in plugins/planning/reference/.
  • /review:quality-gate code-design resolves: plugins/review/skills/quality-gate/SKILL.md lists the mode.
  • Cross-plugin citations use /plugin:skill form (/docs-hygiene:extract-ssot, /playbooks:skill-authoring, /docs-hygiene:write-for-agents), and the planning→review dependency direction holds.
  • The two secondaries (composition over inheritance, coupling and cohesion) and the Rule of Three secondary are labeled, and they use the required "cited secondary moves or changes, or a recheck reaches the primary" trigger.
  • The consumer-override line, scope line, reuse line and the Markdown pointers are present.
  • The changelog fragment is in the planning plugin's .changes/ directory with a minor bump.

I did not independently verify the author's claimed phase-verifier, scripts/check-affected.sh and typos results. I also did not re-fetch the cited external URLs.

I found no closing-issue criteria that the change fails to meet, and no path-scoped rule that applies. The skill-bodies-state-current-rules rule covers only skills and agents, and this file is under reference/.

@kyle-sexton
kyle-sexton added this pull request to the merge queue Oct 19, 2026
Merged via the queue into main with commit e54fbb6 Oct 19, 2026
40 of 41 checks passed
@kyle-sexton
kyle-sexton deleted the feat/8332-design-principles-reference branch October 19, 2026 05:21
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.

feat(planning): add the bundled design-principles reference

1 participant