Skip to content

Add design rules and review questions - #4

Merged
elkaix merged 1 commit into
mainfrom
design-rules
Oct 1, 2026
Merged

elkaix merged 1 commit into
mainfrom
design-rules

Conversation

@elkaix

@elkaix elkaix commented Oct 1, 2026 •

Copy link
Copy Markdown
Contributor

Integrates the "Generalized Coding Practices" set into the skill without adding a file, keeping the SKILL.md + two-references layout from AGENTS.md.

Changes

  • SKILL.md — new ## 3. Design section (seven rule groups: ownership, boundaries, effects, failure, dependencies, change surface, tests) plus the conflict priority order and the "adding code, or a new place to understand?" test. Implement step points to it; Review step asks the review questions for Substantial work and above. Sections renumbered. 175 lines.
  • references/quality-gates.md — domain-specific practices folded into the matching rows (APIs: stable/versioned contracts; Concurrency: locks released before slow work, shared mutable state minimized; Security: secure defaults, centralized authorization, stronger validation on destructive ops; Performance: algorithmic first, fast path with fallback; Operations: config loaded once at startup, observability designed with the feature). New ## Review questions section (25 source questions condensed to 10).
  • README.md — mirrors the new design-rules behavior.

Not done

  • A third reference file was deliberately not added because AGENTS.md fixes the layout at two references.
  • Source material already covered by the skill (boundary validation, explicit failure, smallest shared layer, dead-code removal, dependency direction, resource pairing, least privilege, measure-before-optimize) was not restated.
  • Phrased as positive imperatives, no language-specific code examples.

Verification

Ran the docs workflow steps locally: frontmatter checks pass, SKILL.md is 175 ≤ 200 lines, no broken local links.

Summary by CodeRabbit

  • Documentation
    • Expanded design guidance to cover ownership, boundaries, side effects, failure handling, dependencies, change scope, and tests.
    • Clarified how to prioritize design rules when they conflict and added review questions for substantial changes.
    • Added quality-gate guidance for public contracts, concurrency, authorization, validation, fast paths, configuration, and telemetry.

Fold maintainability practices into the skill: a Design section in
SKILL.md (ownership, boundaries, effects, failure, dependencies, change
surface, tests, plus a conflict priority order), domain-specific items
in the matching quality-gate rows, and a review-questions list applied
to Substantial work and above. README mirrors the new behavior.
@coderabbitai

coderabbitai Bot commented Oct 1, 2026

Copy link
Copy Markdown

Review in Change Stack →

Navigate logical layers of code changes, visualize relationships, and explore their blast radius.

Note

Currently processing new changes in this PR. This may take a few minutes, please wait...

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Advanced

Run ID: 08fad182-f935-4ac8-b43e-66bc5f4eb1b0

📥 Commits

Reviewing files that changed from the base of the PR and between e6da630 and 9c66ed9.

📒 Files selected for processing (3)
  • README.md
  • SKILL.md
  • references/quality-gates.md
 ___________________________________
< Colonel Panic is my arch-nemesis. >
 -----------------------------------
  \
   \   (\__/)
       (•ㅅ•)
       /   づ
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Commit to this branch
  • Create a new PR
  • Autopilot · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Autopilot is currently an internal CodeRabbit preview.


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@elkaix
elkaix merged commit 4468d8d into main Oct 1, 2026
1 of 2 checks passed
@elkaix
elkaix deleted the design-rules branch October 1, 2026 23:06
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