Initial checkin
This commit is contained in:
50
memory/constitution.md
Normal file
50
memory/constitution.md
Normal file
@@ -0,0 +1,50 @@
|
||||
# [PROJECT_NAME] Constitution
|
||||
<!-- Example: Spec Constitution, TaskFlow Constitution, etc. -->
|
||||
|
||||
## Core Principles
|
||||
|
||||
### [PRINCIPLE_1_NAME]
|
||||
<!-- Example: I. Library-First -->
|
||||
[PRINCIPLE_1_DESCRIPTION]
|
||||
<!-- Example: Every feature starts as a standalone library; Libraries must be self-contained, independently testable, documented; Clear purpose required - no organizational-only libraries -->
|
||||
|
||||
### [PRINCIPLE_2_NAME]
|
||||
<!-- Example: II. CLI Interface -->
|
||||
[PRINCIPLE_2_DESCRIPTION]
|
||||
<!-- Example: Every library exposes functionality via CLI; Text in/out protocol: stdin/args → stdout, errors → stderr; Support JSON + human-readable formats -->
|
||||
|
||||
### [PRINCIPLE_3_NAME]
|
||||
<!-- Example: III. Test-First (NON-NEGOTIABLE) -->
|
||||
[PRINCIPLE_3_DESCRIPTION]
|
||||
<!-- Example: TDD mandatory: Tests written → User approved → Tests fail → Then implement; Red-Green-Refactor cycle strictly enforced -->
|
||||
|
||||
### [PRINCIPLE_4_NAME]
|
||||
<!-- Example: IV. Integration Testing -->
|
||||
[PRINCIPLE_4_DESCRIPTION]
|
||||
<!-- Example: Focus areas requiring integration tests: New library contract tests, Contract changes, Inter-service communication, Shared schemas -->
|
||||
|
||||
### [PRINCIPLE_5_NAME]
|
||||
<!-- Example: V. Observability, VI. Versioning & Breaking Changes, VII. Simplicity -->
|
||||
[PRINCIPLE_5_DESCRIPTION]
|
||||
<!-- Example: Text I/O ensures debuggability; Structured logging required; Or: MAJOR.MINOR.BUILD format; Or: Start simple, YAGNI principles -->
|
||||
|
||||
## [SECTION_2_NAME]
|
||||
<!-- Example: Additional Constraints, Security Requirements, Performance Standards, etc. -->
|
||||
|
||||
[SECTION_2_CONTENT]
|
||||
<!-- Example: Technology stack requirements, compliance standards, deployment policies, etc. -->
|
||||
|
||||
## [SECTION_3_NAME]
|
||||
<!-- Example: Development Workflow, Review Process, Quality Gates, etc. -->
|
||||
|
||||
[SECTION_3_CONTENT]
|
||||
<!-- Example: Code review requirements, testing gates, deployment approval process, etc. -->
|
||||
|
||||
## Governance
|
||||
<!-- Example: Constitution supersedes all other practices; Amendments require documentation, approval, migration plan -->
|
||||
|
||||
[GOVERNANCE_RULES]
|
||||
<!-- Example: All PRs/reviews must verify compliance; Complexity must be justified; Use [GUIDANCE_FILE] for runtime development guidance -->
|
||||
|
||||
**Version**: [CONSTITUTION_VERSION] | **Ratified**: [RATIFICATION_DATE] | **Last Amended**: [LAST_AMENDED_DATE]
|
||||
<!-- Example: Version: 2.1.1 | Ratified: 2025-06-13 | Last Amended: 2025-07-16 -->
|
||||
85
memory/constitution_update_checklist.md
Normal file
85
memory/constitution_update_checklist.md
Normal file
@@ -0,0 +1,85 @@
|
||||
# Constitution Update Checklist
|
||||
|
||||
When amending the constitution (`/memory/constitution.md`), ensure all dependent documents are updated to maintain consistency.
|
||||
|
||||
## Templates to Update
|
||||
|
||||
### When adding/modifying ANY article:
|
||||
- [ ] `/templates/plan-template.md` - Update Constitution Check section
|
||||
- [ ] `/templates/spec-template.md` - Update if requirements/scope affected
|
||||
- [ ] `/templates/tasks-template.md` - Update if new task types needed
|
||||
- [ ] `/.claude/commands/plan.md` - Update if planning process changes
|
||||
- [ ] `/.claude/commands/tasks.md` - Update if task generation affected
|
||||
- [ ] `/CLAUDE.md` - Update runtime development guidelines
|
||||
|
||||
### Article-specific updates:
|
||||
|
||||
#### Article I (Library-First):
|
||||
- [ ] Ensure templates emphasize library creation
|
||||
- [ ] Update CLI command examples
|
||||
- [ ] Add llms.txt documentation requirements
|
||||
|
||||
#### Article II (CLI Interface):
|
||||
- [ ] Update CLI flag requirements in templates
|
||||
- [ ] Add text I/O protocol reminders
|
||||
|
||||
#### Article III (Test-First):
|
||||
- [ ] Update test order in all templates
|
||||
- [ ] Emphasize TDD requirements
|
||||
- [ ] Add test approval gates
|
||||
|
||||
#### Article IV (Integration Testing):
|
||||
- [ ] List integration test triggers
|
||||
- [ ] Update test type priorities
|
||||
- [ ] Add real dependency requirements
|
||||
|
||||
#### Article V (Observability):
|
||||
- [ ] Add logging requirements to templates
|
||||
- [ ] Include multi-tier log streaming
|
||||
- [ ] Update performance monitoring sections
|
||||
|
||||
#### Article VI (Versioning):
|
||||
- [ ] Add version increment reminders
|
||||
- [ ] Include breaking change procedures
|
||||
- [ ] Update migration requirements
|
||||
|
||||
#### Article VII (Simplicity):
|
||||
- [ ] Update project count limits
|
||||
- [ ] Add pattern prohibition examples
|
||||
- [ ] Include YAGNI reminders
|
||||
|
||||
## Validation Steps
|
||||
|
||||
1. **Before committing constitution changes:**
|
||||
- [ ] All templates reference new requirements
|
||||
- [ ] Examples updated to match new rules
|
||||
- [ ] No contradictions between documents
|
||||
|
||||
2. **After updating templates:**
|
||||
- [ ] Run through a sample implementation plan
|
||||
- [ ] Verify all constitution requirements addressed
|
||||
- [ ] Check that templates are self-contained (readable without constitution)
|
||||
|
||||
3. **Version tracking:**
|
||||
- [ ] Update constitution version number
|
||||
- [ ] Note version in template footers
|
||||
- [ ] Add amendment to constitution history
|
||||
|
||||
## Common Misses
|
||||
|
||||
Watch for these often-forgotten updates:
|
||||
- Command documentation (`/commands/*.md`)
|
||||
- Checklist items in templates
|
||||
- Example code/commands
|
||||
- Domain-specific variations (web vs mobile vs CLI)
|
||||
- Cross-references between documents
|
||||
|
||||
## Template Sync Status
|
||||
|
||||
Last sync check: 2025-07-16
|
||||
- Constitution version: 2.1.1
|
||||
- Templates aligned: ❌ (missing versioning, observability details)
|
||||
|
||||
---
|
||||
|
||||
*This checklist ensures the constitution's principles are consistently applied across all project documentation.*
|
||||
Reference in New Issue
Block a user