constitution.md•4.67 kB
<!--
Sync Impact Report
- Version change: N/A → 1.0.0
- Modified principles: N/A (initial adoption)
- Added sections: Core Principles (4), Quality Gates, Development Workflow & Review Process, Governance
- Removed sections: Unused fifth principle placeholder
- Templates requiring updates:
- .specify/templates/plan-template.md — ✅ aligned (added Constitution Check checklist)
- .specify/templates/spec-template.md — ✅ aligned (no change required)
- .specify/templates/tasks-template.md — ✅ updated (tests are required by default)
- .specify/templates/commands/* — ⚠ pending (directory not present in repo)
- Deferred TODOs:
- RATIFICATION_DATE — original adoption date unknown; needs project owner input
-->
# Debug-MCP Constitution
## Core Principles
### Code Quality Discipline
- MUST enforce automated formatting and linting on every change (no new warnings on main).
- MUST maintain cyclomatic complexity and function length within agreed limits or include a documented exception in the plan.
- MUST include clear, purpose-driven comments for non-obvious logic and public APIs with docstrings.
- SHOULD favor small, composable modules and eliminate dead code in the same PR when discovered.
Rationale: High code quality reduces defects, eases reviews, and accelerates onboarding.
### Testing Standards (NON-NEGOTIABLE)
- MUST include automated tests for all new functionality and for bug fixes reproducing the defect.
- MUST keep repository-wide line or branch coverage ≥ 80% and not decrease coverage on touched files.
- SHOULD apply testing pyramid: unit first; add integration/contract tests when crossing boundaries.
- MUST make tests deterministic, hermetic, and fast (< 2 min PR test suite unless justified in plan).
Rationale: Reliable, fast tests are the primary safety net enabling confident iteration.
### User Experience Consistency
- MUST adhere to the project’s design system; if none, use platform defaults consistently and document decisions in plan.md.
- MUST meet basic accessibility: keyboard navigability, color contrast, labels for controls; provide alt text for media.
- MUST keep terminology, empty states, and error messaging consistent and actionable.
- SHOULD localize user-facing strings when an i18n framework is present, otherwise prepare for future localization.
Rationale: Consistency and accessibility increase user trust and reduce support burden.
### Performance Requirements
- MUST declare performance goals and constraints in plan.md for performance-sensitive features.
- MUST provide evidence (benchmarks, profiles, or measurements) when changes may affect hot paths.
- SHOULD meet declared goals; if goals are absent, defaults apply: p95 latency < 200 ms and steady-state memory overhead < 100 MB for typical operations. UI targets: 60 fps rendering, input latency < 100 ms.
- MUST avoid pathological regressions; if trade-offs are accepted, document rationale and mitigation.
Rationale: Known budgets prevent accidental regressions and guide architectural choices.
## Quality Gates
Before merge, every PR MUST satisfy:
- Lint/format passes with zero new warnings on changed files.
- All tests pass; coverage ≥ 80% and no decrease for touched files.
- UX checklist completed for user-facing changes (consistency + basic accessibility).
- Performance goals declared and measured when relevant; no significant regression without approved exception.
- Documentation updated for public APIs and noteworthy behavior changes.
## Development Workflow & Review Process
- Work in small, reviewable PRs with clear scope and test evidence.
- Require at least one reviewer approval and automated checks green.
- Prefer “spec → plan → implement → tasks” flow for substantial features; small fixes may inline a minimal plan in the PR.
- Breaking changes require migration notes and versioning strategy in the plan/spec.
- Security, privacy, and data handling concerns MUST be called out explicitly when applicable.
## Governance
- This Constitution supersedes conflicting guidance in templates or docs.
- Amendments require: proposal in PR, rationale, impact analysis, and updates across dependent templates.
- Versioning uses SemVer:
- MAJOR: Backward-incompatible governance changes or removed principles.
- MINOR: New principle/section or materially expanded guidance.
- PATCH: Clarifications, wording, or non-semantic refinements.
- Compliance reviews: Periodic audits verify Quality Gates and principles; violations require remediation tasks.
**Version**: 1.0.0 | **Ratified**: TODO(RATIFICATION_DATE): original adoption date unknown; please provide | **Last Amended**: 2025-10-22