56 lines
2.1 KiB
Markdown
56 lines
2.1 KiB
Markdown
---
|
|
version: [CONSTITUTION_VERSION]
|
|
ratified: [RATIFICATION_DATE]
|
|
lastAmended: [LAST_AMENDMENT_DATE]
|
|
---
|
|
<!-- Example: version: 2.1.1, ratified: 2025-10-21, lastAmended: 2025-10-21 -->
|
|
<!--
|
|
AMENDMENT REPORT
|
|
===
|
|
|
|
[SUMMARY_OF_CHANGES]
|
|
-->
|
|
|
|
# [PROJECT_NAME] Constitution
|
|
<!-- Example: Spec Constitution, TaskFlow Constitution, etc. -->
|
|
|
|
## Principles
|
|
|
|
### [PRINCIPLE_1_NAME]
|
|
<!-- Example: I. Test-First (NON-NEGOTIABLE) -->
|
|
[PRINCIPLE_1_DESCRIPTION]
|
|
<!-- Example: TDD mandatory: Tests written → User approved → Tests fail → Then implement; Red-Green-Refactor cycle strictly enforced -->
|
|
|
|
### [PRINCIPLE_2_NAME]
|
|
<!-- Example: II. Integration Testing -->
|
|
[PRINCIPLE_2_DESCRIPTION]
|
|
<!-- Example: Focus areas requiring integration tests: user-facing oriented over unit tests, making sure new features work end-to-end -->
|
|
|
|
### [PRINCIPLE_3_NAME]
|
|
<!-- Example: III. Simplicity and YAGNI -->
|
|
[PRINCIPLE_3_DESCRIPTION]
|
|
<!-- Example: Start simple and stupid, only implement what is necessary now; Incrementally enhance as needed -->
|
|
|
|
### [PRINCIPLE_4_NAME]
|
|
<!-- Example: IV. Cohesion over Coupling -->
|
|
[PRINCIPLE_4_DESCRIPTION]
|
|
<!-- Example: Group related functionality together as modules, libraries, or services; Use simple and clear interfaces for interaction -->
|
|
|
|
### [PRINCIPLE_5_NAME]
|
|
<!-- Example: V. Observability, VI. Versioning & Breaking Changes, VII. Convention over Configuration -->
|
|
[PRINCIPLE_5_DESCRIPTION]
|
|
<!-- Example: Structured logging required; Or: MAJOR.MINOR.BUILD format; Or: minimize configuration files by following conventions -->
|
|
|
|
## [SECTION_2_NAME]
|
|
<!-- Example: Other Requirements, Technical Standards, etc. -->
|
|
<!-- Omit if not applicable or not needed -->
|
|
|
|
[SECTION_2_CONTENT]
|
|
<!-- Example: Performance requirements, security standards, coding style guidelines, etc. -->
|
|
|
|
## Governance
|
|
<!-- Example: Approval processes, review requirements, compliance checks, etc. -->
|
|
|
|
[GOVERNANCE_RULES]
|
|
<!-- Example: All changes must be reviewed by at least two team members; Self-reviews before submission; All changes must pass CI tests before merging, the security review for sensitive modules, etc. -->
|