265 lines
5.0 KiB
Markdown
265 lines
5.0 KiB
Markdown
# Session Handoff Template
|
|
|
|
This template shows the structure and content of session handoff documents generated by `session.py end --handoff`.
|
|
|
|
---
|
|
|
|
# Session Handoff: [Feature/Branch Name]
|
|
|
|
**Session ID**: [branch-name]-[date]
|
|
**Branch**: [branch-name]
|
|
**Date**: [YYYY-MM-DD HH:MM UTC]
|
|
**Duration**: [X hours Y minutes]
|
|
**Commit**: [SHA] "[commit message]"
|
|
|
|
---
|
|
|
|
## 🎯 Session Objective
|
|
|
|
**Primary Goal**: [Primary objective description]
|
|
|
|
**Success Criteria**:
|
|
- [x] [Completed criterion 1]
|
|
- [x] [Completed criterion 2]
|
|
- [ ] [Incomplete criterion]
|
|
|
|
**Achievement**: [✅ Complete / 🚧 Partial / ❌ Not met]
|
|
|
|
---
|
|
|
|
## ✅ Completed Work
|
|
|
|
### Features Implemented
|
|
|
|
**1. [Feature Name]** (Commit: [SHA])
|
|
- [Implementation detail 1]
|
|
- [Implementation detail 2]
|
|
- [Implementation detail 3]
|
|
|
|
**2. [Feature Name]** (Commit: [SHA])
|
|
- [Implementation detail 1]
|
|
- [Implementation detail 2]
|
|
|
|
### Tests Added
|
|
|
|
**Unit Tests**: [N] new tests
|
|
- `test_[module].py`: [N] tests
|
|
- `test_[module].py`: [N] tests
|
|
|
|
**Integration Tests**: [N] new tests
|
|
- [Description of integration tests]
|
|
|
|
**Coverage**: [XX.X]% → [YY.Y]% **(+Z.Z%)**
|
|
|
|
### Documentation
|
|
|
|
- [Documentation item 1]
|
|
- [Documentation item 2]
|
|
- [Documentation item 3]
|
|
|
|
---
|
|
|
|
## 🚧 Work In Progress
|
|
|
|
**[Feature/Task Name]**
|
|
- Current state: [X]% complete
|
|
- Remaining work: [Description]
|
|
- Next steps: [Action items]
|
|
|
|
---
|
|
|
|
## 🚫 Blockers
|
|
|
|
### Blocker 1: [Blocker Name]
|
|
**Issue**: [Issue ID if applicable]
|
|
**Status**: [Active / Resolved]
|
|
**Duration**: [Time blocked]
|
|
**Resolution**: [How resolved or path to resolution]
|
|
**Impact**: [Impact description]
|
|
|
|
### Blocker 2: [Blocker Name]
|
|
**Status**: [Active]
|
|
**Blocking**: [What is blocked]
|
|
**Next Steps**: [What needs to happen]
|
|
|
|
---
|
|
|
|
## 📋 Decisions Made
|
|
|
|
### D-[DATE]-1: [Decision Title]
|
|
**Context**: [Why this decision was needed]
|
|
**Decision**: [What was decided]
|
|
**Rationale**: [Why this approach was chosen]
|
|
|
|
**Alternatives Considered**:
|
|
- [Alternative 1]: [Why not chosen]
|
|
- [Alternative 2]: [Why not chosen]
|
|
|
|
**Impact**:
|
|
- [Impact item 1]
|
|
- [Impact item 2]
|
|
|
|
**Consequences**:
|
|
- [Consequence 1]
|
|
- [Consequence 2]
|
|
|
|
---
|
|
|
|
## 🏗️ Architecture & Patterns
|
|
|
|
### Patterns Applied
|
|
|
|
**[Pattern Name]**
|
|
- [How pattern was applied]
|
|
- [Benefits realized]
|
|
- [Considerations]
|
|
|
|
### Pattern Compliance
|
|
|
|
**Compliance Score**: [XX]%
|
|
|
|
**Violations** (if any):
|
|
- `[file]:[line]`: [Violation description] - [Status]
|
|
|
|
**Improvements**:
|
|
- [Improvement made 1]
|
|
- [Improvement made 2]
|
|
|
|
---
|
|
|
|
## 📊 Session Metrics
|
|
|
|
### Time Breakdown
|
|
- **Active Coding**: [X hours Y minutes]
|
|
- **Testing**: [X hours Y minutes]
|
|
- **Documentation**: [X minutes]
|
|
- **Blocked Time**: [X hours] ([Reason])
|
|
|
|
### Code Changes
|
|
- **Files Modified**: [N]
|
|
- **Files Added**: [N]
|
|
- **Lines Added**: [N]
|
|
- **Lines Removed**: [N]
|
|
- **Net Change**: [+/-N] lines
|
|
|
|
### Commits
|
|
- **Total Commits**: [N]
|
|
- **Feature Commits**: [N]
|
|
- **Test Commits**: [N]
|
|
- **Documentation Commits**: [N]
|
|
|
|
### Quality Metrics
|
|
- **Tests Added**: [N]
|
|
- **Tests Passing**: [N] ([X]%)
|
|
- **Coverage**: [XX.X]% (+[Z.Z]%, [above/below] threshold)
|
|
- **Build Status**: [✅ Passing / ❌ Failing]
|
|
- **Linter Warnings**: [N]
|
|
|
|
---
|
|
|
|
## 📁 Key Files
|
|
|
|
### Core Implementation
|
|
- `[path/to/file]` - [Description]
|
|
- `[path/to/file]` - [Description]
|
|
|
|
### Tests
|
|
- `[path/to/test]` - [Description]
|
|
- `[path/to/test]` - [Description]
|
|
|
|
### Documentation
|
|
- `[path/to/doc]` - [Description]
|
|
|
|
---
|
|
|
|
## ⚠️ Important Notes
|
|
|
|
### For Next Developer
|
|
|
|
**Critical Points**:
|
|
1. [Critical point 1]
|
|
2. [Critical point 2]
|
|
|
|
**Testing**:
|
|
- [Testing consideration 1]
|
|
- [Testing consideration 2]
|
|
|
|
**Deployment**:
|
|
- [Deployment consideration 1]
|
|
- [Deployment consideration 2]
|
|
|
|
---
|
|
|
|
## 🔄 Next Steps (If Continuing)
|
|
|
|
1. [Next action item 1]
|
|
2. [Next action item 2]
|
|
3. [Next action item 3]
|
|
|
|
**Estimated**: [Time estimate]
|
|
|
|
**Potential Enhancements** (Future work):
|
|
- [Enhancement 1]
|
|
- [Enhancement 2]
|
|
|
|
---
|
|
|
|
## 🎓 Learnings & Insights
|
|
|
|
### What Went Well
|
|
- [Success 1]
|
|
- [Success 2]
|
|
|
|
### Challenges Overcome
|
|
- [Challenge 1]: [How overcome]
|
|
- [Challenge 2]: [How overcome]
|
|
|
|
### What Could Be Improved
|
|
- [Improvement opportunity 1]
|
|
- [Improvement opportunity 2]
|
|
|
|
### Recommendations for Similar Work
|
|
- [Recommendation 1]
|
|
- [Recommendation 2]
|
|
|
|
---
|
|
|
|
## 📊 Session Summary
|
|
|
|
**Objective Achievement**: [✅ 100% / 🚧 XX% / ❌ Not met]
|
|
**Quality Score**: [A+ / A / B / C / D]
|
|
**Velocity**: [N] lines/hour (net code)
|
|
**Decision Points**: [N] architectural decisions recorded
|
|
**Blockers**: [N] encountered, [N] resolved
|
|
|
|
**Overall Assessment**: [Brief assessment]
|
|
|
|
---
|
|
|
|
## 🔗 Related Resources
|
|
|
|
- **Pull Request**: #[N]
|
|
- **Issue Tracker**: [Issue IDs]
|
|
- **Build**: [Build link] ([Status])
|
|
- **Documentation**: [Doc links]
|
|
|
|
---
|
|
|
|
## 📝 Handoff Checklist
|
|
|
|
- [ ] All code committed and pushed
|
|
- [ ] Tests passing
|
|
- [ ] Coverage above threshold
|
|
- [ ] Documentation updated
|
|
- [ ] Decisions recorded
|
|
- [ ] Branch merged (if applicable)
|
|
- [ ] Issues updated
|
|
- [ ] Session metrics recorded
|
|
|
|
**Status**: [✅ Ready / 🚧 Pending / ❌ Incomplete]
|
|
|
|
---
|
|
|
|
**Generated by Session Manager**
|
|
**Session Archive**: `.git/sessions/history/[session-id].json`
|