104 lines
2.6 KiB
Markdown
104 lines
2.6 KiB
Markdown
# <!-- TODO: Constitution Name, e.g., API Design Constitution -->
|
|
|
|
**Type**: `constitution`
|
|
**Status**: <!-- TODO: draft | active | deprecated -->
|
|
**Domain**: <!-- TODO: e.g., api-design, code-review, architecture, testing -->
|
|
|
|
---
|
|
|
|
## Overview
|
|
|
|
### Purpose
|
|
|
|
<!-- TODO: 1-2 sentences describing what this constitution governs and why it exists -->
|
|
|
|
### Scope
|
|
|
|
**Applies to**:
|
|
<!-- TODO: List what this constitution covers:
|
|
- What this constitution covers
|
|
- Specific areas or scenarios
|
|
-->
|
|
|
|
**Does not apply to**:
|
|
<!-- TODO: List explicit exclusions:
|
|
- Explicit exclusions
|
|
- Out of scope scenarios
|
|
-->
|
|
|
|
---
|
|
|
|
## Articles
|
|
|
|
### Article 1: <!-- TODO: Principle Name -->
|
|
|
|
**Principle**: <!-- TODO: Clear, actionable statement of the principle -->
|
|
|
|
**Rationale**: <!-- TODO: Why this principle matters and what problems it solves -->
|
|
|
|
**Examples**:
|
|
<!-- TODO: Provide good and bad examples:
|
|
- ✅ **Good**: Brief example demonstrating the principle
|
|
- ❌ **Bad**: Brief counter-example violating the principle
|
|
-->
|
|
|
|
**Exceptions**: <!-- TODO: When this principle may not apply, or "None" -->
|
|
|
|
---
|
|
|
|
### Article 2: <!-- TODO: Principle Name -->
|
|
|
|
**Principle**: <!-- TODO: Clear, actionable statement of the principle -->
|
|
|
|
**Rationale**: <!-- TODO: Why this principle matters and what problems it solves -->
|
|
|
|
**Examples**:
|
|
<!-- TODO: Provide good and bad examples:
|
|
- ✅ **Good**: Brief example demonstrating the principle
|
|
- ❌ **Bad**: Brief counter-example violating the principle
|
|
-->
|
|
|
|
**Exceptions**: <!-- TODO: When this principle may not apply, or "None" -->
|
|
|
|
---
|
|
|
|
### Article 3: <!-- TODO: Principle Name -->
|
|
|
|
**Principle**: <!-- TODO: Clear, actionable statement of the principle -->
|
|
|
|
**Rationale**: <!-- TODO: Why this principle matters and what problems it solves -->
|
|
|
|
**Examples**:
|
|
<!-- TODO: Provide good and bad examples:
|
|
- ✅ **Good**: Brief example demonstrating the principle
|
|
- ❌ **Bad**: Brief counter-example violating the principle
|
|
-->
|
|
|
|
**Exceptions**: <!-- TODO: When this principle may not apply, or "None" -->
|
|
|
|
---
|
|
|
|
<!-- TODO: Add more articles as needed (3-7 total recommended). Copy the article template above. -->
|
|
|
|
---
|
|
|
|
## Governance
|
|
|
|
### Amendment Process
|
|
|
|
<!-- TODO: How this constitution can be modified. Example: "Amendments require team consensus and PR approval" -->
|
|
|
|
### Enforcement
|
|
|
|
<!-- TODO: How adherence is ensured. Example: "Enforced through code review checklist" or "Validated in CI/CD pipeline" -->
|
|
|
|
### Conflict Resolution
|
|
|
|
<!-- TODO: How conflicts with other constitutions or guidelines are resolved -->
|
|
|
|
---
|
|
|
|
## Notes
|
|
|
|
<!-- TODO: OPTIONAL - Remove if not applicable. Any additional context, references, or clarifications -->
|