Skip to content

Latest commit

 

History

History
24 lines (17 loc) · 957 Bytes

File metadata and controls

24 lines (17 loc) · 957 Bytes

Common Rules

This directory contains language-agnostic engineering rules.

Canonical Placement

  • Rule entry: docs/rules/common/{rule-topic}.md
  • coding-style.md - naming, code structure, comments, and formatting defaults
  • security.md - secret handling, input validation, dependency safety, and logging constraints
  • git-workflow.md - branch, commit, PR, review, and merge expectations
  • patterns.md - reuse conventions, decision scope, modularity, and error-handling patterns
  • testing.md - test scope, quality criteria, coverage priorities, and verification expectations

File Convention

  • Keep one topic per file
  • Use concise, actionable guidance
  • Keep guidance broadly applicable across languages and frameworks

How to Use

  1. Start here before applying language-specific or framework-specific rules.
  2. Follow these rules as defaults when no narrower rule overrides them.
  3. Update rule files when team conventions change.