forked from trent_larson/crowd-funder-for-time-pwa
a224aced85
- Reorganize cursor rules into logical domain-based directories - Implement meta-rule system for workflow-specific rule bundling - Move core rules to dedicated /core directory - Consolidate development rules under /development namespace - Add architectural patterns and implementation examples - Create workflow-specific meta-rules for common development tasks - Remove deprecated standalone rule files - Update package dependencies for new rule structure BREAKING CHANGE: Cursor rules file structure has been reorganized Files moved from root rules directory to domain-specific subdirectories
99 lines
2.5 KiB
Plaintext
99 lines
2.5 KiB
Plaintext
---
|
|
alwaysApply: false
|
|
---
|
|
|
|
# ADR Template
|
|
|
|
## ADR-XXXX-YY-ZZ: [Short Title]
|
|
|
|
**Date:** YYYY-MM-DD
|
|
**Status:** [PROPOSED | ACCEPTED | REJECTED | DEPRECATED | SUPERSEDED]
|
|
**Deciders:** [List of decision makers]
|
|
**Technical Story:** [Link to issue/PR if applicable]
|
|
|
|
## Context
|
|
|
|
[Describe the forces at play, including technological, political, social, and
|
|
project local. These forces are probably in tension, and should be called out as
|
|
such. The language in this section is value-neutral. It is simply describing
|
|
facts.]
|
|
|
|
## Decision
|
|
|
|
[Describe our response to these forces. We will use the past tense (
|
|
"We will...").]
|
|
|
|
## Consequences
|
|
|
|
### Positive
|
|
|
|
- [List positive consequences]
|
|
|
|
### Negative
|
|
|
|
- [List negative consequences or trade-offs]
|
|
|
|
### Neutral
|
|
|
|
- [List neutral consequences or notes]
|
|
|
|
## Alternatives Considered
|
|
|
|
- **Alternative 1:** [Description] - [Why rejected]
|
|
|
|
- **Alternative 2:** [Description] - [Why rejected]
|
|
|
|
- **Alternative 3:** [Description] - [Why rejected]
|
|
|
|
## Implementation Notes
|
|
|
|
[Any specific implementation details, migration steps, or
|
|
technical considerations]
|
|
|
|
## References
|
|
|
|
- [Link to relevant documentation]
|
|
|
|
- [Link to related ADRs]
|
|
|
|
- [Link to external resources]
|
|
|
|
## Related Decisions
|
|
|
|
- [List related ADRs or decisions]
|
|
|
|
---
|
|
|
|
## Usage Guidelines
|
|
|
|
1. **Copy this template** for new ADRs
|
|
2. **Number sequentially** (ADR-001, ADR-002, etc.)
|
|
3. **Use descriptive titles** that clearly indicate the decision
|
|
4. **Include all stakeholders** in the deciders list
|
|
5. **Link to related issues** and documentation
|
|
6. **Update status** as decisions evolve
|
|
7. **Store in** `doc/architecture-decisions/` directory
|
|
|
|
## Model Implementation Checklist
|
|
|
|
### Before ADR Creation
|
|
|
|
- [ ] **Decision Context**: Understand the decision that needs to be made
|
|
- [ ] **Stakeholder Identification**: Identify all decision makers
|
|
- [ ] **Research**: Research alternatives and gather evidence
|
|
- [ ] **Template Selection**: Choose appropriate ADR template
|
|
|
|
### During ADR Creation
|
|
|
|
- [ ] **Context Documentation**: Document the context and forces at play
|
|
- [ ] **Decision Recording**: Record the decision and rationale
|
|
- [ ] **Consequences Analysis**: Analyze positive, negative, and neutral consequences
|
|
- [ ] **Alternatives Documentation**: Document alternatives considered
|
|
|
|
### After ADR Creation
|
|
|
|
- [ ] **Review**: Review ADR with stakeholders
|
|
- [ ] **Approval**: Get approval from decision makers
|
|
- [ ] **Communication**: Communicate decision to team
|
|
- [ ] **Implementation**: Plan implementation of the decision
|