Back to list
Keithagy

project-patterns

by Keithagy

an ironically-named agent workflow for you to make yours

0🍴 0📅 Jan 16, 2026

SKILL.md


name: project-patterns description: Project-specific architectural patterns and tribal knowledge. Copy this skill to your project's .claude/skills/ and customize with your team's conventions, decision trees, and critical pitfalls.

Project Patterns (Template)

This is a template skill. Copy it to your project's .claude/skills/project-patterns/ directory and customize it with your team's tribal knowledge.

This skill provides authoritative guidance on architectural patterns and implementation practices specific to YOUR project. Claude automatically invokes this skill when working on design, planning, or implementation tasks.

How to Use This Template

  1. Copy this entire project-patterns/ directory to your project's .claude/skills/
  2. Edit this SKILL.md to describe your project's architecture
  3. Add your decision trees and patterns to patterns/
  4. Document critical pitfalls in examples/pitfalls.md
  5. Commands like /plan and /techdesign will automatically reference this skill

When to Use This Skill

Configure this table for YOUR project:

Pattern AreaUse When
State ManagementDeciding where state lives (e.g., database vs cache vs memory)
Type SelectionChoosing data types for precision-critical values
Message SchemasAdding/modifying API schemas or message types
Service PatternsImplementing service layers, handlers, middleware
Testing PatternsWriting tests for your specific tech stack
Critical PitfallsAvoiding mistakes that corrupt state or cause outages

Quick Decision Trees

Create decision trees for common architectural decisions in your project:

Where Should State Live?

_Customize this for your architecture_

Is it user-facing data?
├─ Yes → Primary database
└─ No
   ├─ Is it frequently accessed? → Cache layer
   └─ Is it temporary/derived? → In-memory

What Data Type?

_Customize this for your language/framework_

Is it monetary or precision-critical?
├─ Yes → [Your precision type, e.g., Decimal, BigInt]
└─ No
   ├─ Is it an identifier? → [Your ID type]
   └─ Is it a counter? → [Your counter type]

Pattern Files

Create detailed patterns in the patterns/ directory:

PatternFilePhase
State Managementpatterns/state-management.mdDesign
Type Selectionpatterns/type-selection.mdDesign
Service Patternspatterns/service-patterns.mdImplementation
Testing Patternspatterns/testing-patterns.mdImplementation
Critical Pitfallsexamples/pitfalls.mdBoth

Phase Appropriateness

Design Phase (what to build):

  • State management decisions
  • Type/precision choices
  • Component responsibilities
  • API contract shapes
  • Failure mode analysis

Implementation Phase (how to build):

  • Schema/codegen commands
  • File path conventions
  • Service/handler patterns
  • Testing commands

Service Topology

Document your project's services here:

[Service A] → [Service B] → [Service C]
     ↓
[Database]

Core Libraries

Document your project's key libraries and utilities:

  • Types: path/to/types/
  • Utilities: path/to/utils/
  • Validation: path/to/validation/

Common File Patterns

Document where to find common file types:

  • Service entry points: src/services/*/index.ts
  • API handlers: src/api/*Handler.ts
  • Database models: src/models/*.ts
  • Tests: src/**/*.test.ts

Never Do

List critical rules for your project:

  • Never modify X without Y
  • Never bypass validation in Z
  • Never commit secrets to version control

Example: E-commerce Platform Patterns

This example shows how a real project might fill in this template.

Key decisions documented:

  • State management: "Keep business logic in services. Keep controllers thin."
  • Numeric precision: Decimal for monetary, int for counters, float for analytics ratios
  • Critical pitfalls: N+1 queries, missing DB indexes, race conditions in inventory updates

Score

Total Score

45/100

Based on repository quality metrics

SKILL.md

SKILL.mdファイルが含まれている

+20
LICENSE

ライセンスが設定されている

0/10
説明文

100文字以上の説明がある

0/10
人気

GitHub Stars 100以上

0/15
最近の活動

3ヶ月以内に更新がある

0/10
フォーク

10回以上フォークされている

0/5
Issue管理

オープンIssueが50未満

+5
言語

プログラミング言語が設定されている

0/5
タグ

1つ以上のタグが設定されている

0/5

Reviews

💬

Reviews coming soon