architecture-review

Audit GoudEngine codebase for 5-layer dependency hierarchy violations.

6|Updated Oct 29, 2024
One-click install
npx skills add https://github.com/aram-devdocs/GoudEngine --skill architecture-review-aram-devdocs
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: architecture-review
Source: https://github.com/aram-devdocs/GoudEngine/tree/main/.agents/skills/architecture-review
Command: npx skills add https://github.com/aram-devdocs/GoudEngine --skill architecture-review-aram-devdocs

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill ensures the GoudEngine codebase adheres to its strict 5-layer dependency hierarchy, preventing architectural decay and maintaining code integrity.

Core Features & Use Cases

  • Dependency Flow Audit: Identifies and flags violations of the unidirectional dependency rule (Layer N can depend on Layer M where M < N).
  • Module Boundary Validation: Checks for improper type leakage and cross-module dependencies.
  • SDK Logic Review: Ensures SDKs remain thin wrappers and complex logic resides in the core engine.
  • Circular Dependency Detection: Visualizes and reports any circular dependencies between modules.
  • Use Case: After adding a new feature that touches multiple layers, run this audit to confirm no unintended dependencies were introduced and that the architecture remains sound.

Quick Start

Run the architecture review skill to audit the GoudEngine codebase for dependency violations.

Frequently Asked Questions about architecture-review

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I detect circular dependencies in a Rust codebase?

Circular dependency detection in Rust is performed by analyzing `use` statements to map module relationships and generating a custom graph to visualize and report cyclic imports between modules.

How do I enforce a strict layer dependency hierarchy in code review?

Enforcing a strict layer dependency hierarchy during code review involves validating the unidirectional dependency rule, ensuring Layer N only depends on Layer M where M is less than N.

How do I validate module boundaries to prevent improper type leakage?

Validating module boundaries to prevent improper type leakage requires checking for cross-module dependencies and ensuring types do not unintentionally cross established architectural boundaries.

Why should SDKs remain thin wrappers instead of containing complex logic?

SDKs should remain thin wrappers because complex logic must reside in the core engine, ensuring architectural integrity and preventing code duplication or dependency violations across layers.

When should I run an architecture audit on my codebase?

You should run an architecture audit after adding a new feature that touches multiple layers to confirm no unintended dependencies were introduced and that the architectural hierarchy remains sound.

Does this architecture review tool work without external dependencies?

Yes, the architecture review tool works without external dependencies, utilizing internal scripts and references to analyze Rust `use` statements and generate architectural graphs.