Architecture Guidelines

System architecture: modules, project structure, ADRs, and testing. Use when designing or reviewing systems.

majiayu000 bcf03e6 2 files · 2.2 KB Updated 567 repo stars

File contents


name: architecture-guidelines description: System architecture: modules, project structure, ADRs, and testing. Use when designing or reviewing systems.

Architecture Guidelines

Guidelines for system design, project structure, and architectural decisions.

Quick Start

// Use ES Modules with explicit extensions
import * as path from "@std/path";
import { readFile } from "./utils.ts";

export function processFile() {}

Key Principles

  • Use ES Modules (avoid CommonJS/AMD)
  • Follow consistent directory structure with kebab-case directories
  • Document architectural decisions with ADRs including trade-offs
  • Write automated tests with CI (target 80%+ coverage for critical paths)
  • Use naming conventions: PascalCase for components, camelCase for utilities
  • Hexagonal architecture: domain + ports together, adapters separate
  • Explicit composition only: import adapters directly, pass as parameters (no magic config strings, no convenience factories)

References

See rules.md for complete guidelines with examples.

majiayu000/claude-skill-registry-data/tree/main/testing/architecture-guidelines commit bcf03e6ef2

Frequently asked questions

npx skillmds add majiayu000/architecture-guidelines