nitm-ai-dev-toolkit 3.0.15

package/src/repo/templates/feature-plan.template.md

@@ -0,0 +1,202 @@
+# Implementation Plan: {{FEATURE_NAME}}
+
+**Issue:** {{ISSUE_ID}}
+**Spec:** [spec.md](spec.md)
+**Author:** {{AUTHOR}}
+**Created:** {{DATE}}
+**Status:** Draft | In Progress | Completed
+
+## Overview
+
+Brief summary of the implementation approach.
+
+## Prerequisites
+
+Before starting implementation:
+
+- [ ] Feature spec approved
+- [ ] Design reviewed
+- [ ] Dependencies available
+- [ ] Test environment ready
+
+## Architecture
+
+### High-Level Design
+
+```
+[Component diagram or flow chart]
+```
+
+### Component Changes
+
+| Component       | Change Type  | Description       |
+| --------------- | ------------ | ----------------- |
+| {{COMPONENT_1}} | New/Modified | Brief description |
+| {{COMPONENT_2}} | New/Modified | Brief description |
+
+## Implementation Steps
+
+### Phase 1: Foundation
+
+**Estimated Time:** X hours/days
+
+#### Step 1.1: {{STEP_TITLE}}
+
+**Files:**
+
+- `path/to/file1.{{FILE_EXTENSION}}`
+- `path/to/file2.{{FILE_EXTENSION}}`
+
+**Tasks:**
+
+- [ ] Task 1
+- [ ] Task 2
+- [ ] Task 3
+
+**Notes:**
+Implementation details or considerations.
+
+#### Step 1.2: {{STEP_TITLE}}
+
+**Files:**
+
+- `path/to/file.{{FILE_EXTENSION}}`
+
+**Tasks:**
+
+- [ ] Task 1
+- [ ] Task 2
+
+### Phase 2: Core Implementation
+
+**Estimated Time:** X hours/days
+
+#### Step 2.1: {{STEP_TITLE}}
+
+**Files:**
+
+- `path/to/file.{{FILE_EXTENSION}}`
+
+**Tasks:**
+
+- [ ] Task 1
+- [ ] Task 2
+
+### Phase 3: Integration & Testing
+
+**Estimated Time:** X hours/days
+
+#### Step 3.1: Write Tests
+
+**Files:**
+
+- `{{TEST_DIR}}/feature.test.{{FILE_EXTENSION}}`
+
+**Tasks:**
+
+- [ ] Unit tests for component A
+- [ ] Unit tests for component B
+- [ ] Integration tests
+
+#### Step 3.2: Integration
+
+**Tasks:**
+
+- [ ] Connect components
+- [ ] End-to-end validation
+- [ ] Performance testing
+
+## Testing Strategy
+
+### Unit Tests
+
+| Test Case             | Component | Expected Outcome |
+| --------------------- | --------- | ---------------- |
+| Test case description | Component | Expected result  |
+
+### Integration Tests
+
+| Test Scenario        | Components | Expected Outcome |
+| -------------------- | ---------- | ---------------- |
+| Scenario description | A, B, C    | Expected result  |
+
+### Manual Testing
+
+- [ ] Test case 1: Description
+- [ ] Test case 2: Description
+
+## Migration/Deployment
+
+### Database Migrations
+
+```bash
+# Migration commands
+{{MIGRATION_COMMAND}}
+```
+
+### Feature Flags
+
+If using feature flags:
+
+- Flag name: `feature_{{FEATURE_NAME}}`
+- Default: disabled
+- Enable for: specific users/environments
+
+### Rollback Plan
+
+Steps to rollback if issues are discovered:
+
+1. Step 1
+2. Step 2
+3. Step 3
+
+## Dependencies
+
+### External Dependencies
+
+| Dependency   | Version | Purpose         |
+| ------------ | ------- | --------------- |
+| package-name | ^1.0.0  | Why it's needed |
+
+### Internal Dependencies
+
+- Component/service this depends on
+
+## Risks & Mitigations
+
+| Risk             | Mitigation Strategy |
+| ---------------- | ------------------- |
+| Risk description | How to address      |
+
+## Definition of Done
+
+- [ ] All implementation steps completed
+- [ ] Unit tests written and passing
+- [ ] Integration tests written and passing
+- [ ] Code reviewed and approved
+- [ ] Documentation updated
+- [ ] Feature flag configured (if applicable)
+- [ ] Deployed to staging
+- [ ] QA sign-off
+- [ ] Ready for production
+
+## Timeline
+
+| Phase               | Start Date | End Date | Status      |
+| ------------------- | ---------- | -------- | ----------- |
+| Phase 1: Foundation | {{DATE}}   | {{DATE}} | Not Started |
+| Phase 2: Core       | {{DATE}}   | {{DATE}} | Not Started |
+| Phase 3: Testing    | {{DATE}}   | {{DATE}} | Not Started |
+| Deployment          | {{DATE}}   | {{DATE}} | Not Started |
+
+## Notes
+
+Additional implementation notes, decisions made during development, or lessons learned.
+
+---
+
+## Progress Log
+
+| Date     | Update       |
+| -------- | ------------ |
+| {{DATE}} | Plan created |

package/src/repo/templates/feature-spec.template.md

@@ -0,0 +1,148 @@
+# Feature Specification: {{FEATURE_NAME}}
+
+**Issue:** {{ISSUE_ID}}
+**Author:** {{AUTHOR}}
+**Created:** {{DATE}}
+**Status:** Draft | In Review | Approved
+
+## Summary
+
+Brief one-paragraph description of the feature.
+
+## Background
+
+### Problem Statement
+
+What problem does this feature solve? Why is it needed?
+
+### Current Behavior
+
+How does the system currently handle this scenario (if applicable)?
+
+### User Impact
+
+Who is affected and how will this improve their experience?
+
+## Requirements
+
+### Functional Requirements
+
+1. **FR-1:** The system shall...
+2. **FR-2:** The system shall...
+3. **FR-3:** The system shall...
+
+### Non-Functional Requirements
+
+1. **NFR-1:** Performance - The feature shall respond within X ms
+2. **NFR-2:** Security - The feature shall...
+3. **NFR-3:** Accessibility - The feature shall...
+
+## User Stories
+
+### Story 1: {{USER_ROLE}}
+
+**As a** {{USER_ROLE}}
+**I want** {{GOAL}}
+**So that** {{BENEFIT}}
+
+**Acceptance Criteria:**
+
+- [ ] Criterion 1
+- [ ] Criterion 2
+- [ ] Criterion 3
+
+### Story 2: {{USER_ROLE}}
+
+**As a** {{USER_ROLE}}
+**I want** {{GOAL}}
+**So that** {{BENEFIT}}
+
+**Acceptance Criteria:**
+
+- [ ] Criterion 1
+- [ ] Criterion 2
+
+## Design
+
+### User Interface
+
+Describe UI changes, include wireframes or mockups if available.
+
+```
+[Placeholder for wireframe/mockup]
+```
+
+### API Changes
+
+If applicable, describe new or modified API endpoints.
+
+```
+METHOD /api/endpoint
+Request: { ... }
+Response: { ... }
+```
+
+### Data Model
+
+Describe any database schema changes.
+
+```
+Table: {{TABLE_NAME}}
+- column1: type (description)
+- column2: type (description)
+```
+
+## Technical Considerations
+
+### Dependencies
+
+- List any new dependencies or libraries required
+- List any services this feature depends on
+
+### Constraints
+
+- Technical limitations to be aware of
+- Backwards compatibility requirements
+
+### Risks
+
+| Risk             | Probability  | Impact       | Mitigation      |
+| ---------------- | ------------ | ------------ | --------------- |
+| Risk description | Low/Med/High | Low/Med/High | How to mitigate |
+
+## Out of Scope
+
+Explicitly list what is NOT part of this feature:
+
+- Item 1
+- Item 2
+
+## Success Metrics
+
+How will we measure the success of this feature?
+
+- Metric 1: Description and target
+- Metric 2: Description and target
+
+## Timeline
+
+| Milestone           | Target Date |
+| ------------------- | ----------- |
+| Spec Approved       | {{DATE}}    |
+| Implementation Done | {{DATE}}    |
+| Testing Complete    | {{DATE}}    |
+| Release             | {{DATE}}    |
+
+## References
+
+- [Related Issue]({{ISSUE_TRACKER_URL}})
+- [Design Document](link)
+- [Technical RFC](link)
+
+---
+
+## Changelog
+
+| Date     | Author     | Change Description |
+| -------- | ---------- | ------------------ |
+| {{DATE}} | {{AUTHOR}} | Initial draft      |

package/src/repo/templates/monthly-fix-log.template.md

@@ -0,0 +1,91 @@
+# {{MONTH_NAME}} {{YEAR}} - Fixes & Improvements
+
+**Format**: [Keep a Changelog](https://keepachangelog.com/)
+**Period**: {{MONTH_NAME}} 1-{{LAST_DAY}}, {{YEAR}}
+
+## Summary
+
+Brief overview of the month's focus areas and key achievements.
+
+### Key Themes
+
+- Theme 1: [e.g., Performance improvements]
+- Theme 2: [e.g., Security patches]
+- Theme 3: [e.g., TypeScript migration]
+
+### Statistics
+
+- Total fixes: X
+- Complex fixes: Y
+- Breaking changes: Z
+
+---
+
+## [{{YYYY-MM-DD}}] - {{FIX_TITLE}}
+
+### Fixed/Changed/Added
+
+- **Issue**: Brief description of the problem
+  - **Root cause**: Why it happened
+  - **Solution**: How it was fixed
+  - **Files modified**: `path/to/file1.ext`, `path/to/file2.ext`
+  - **Status**: ✅ Fixed | ⏳ In Progress | 🔄 Under Review
+
+### Impact
+
+- 🔧 **Technical**: Performance improved by X%, reduced bundle size, etc.
+- 🎯 **User Experience**: Faster load times, better error messages, etc.
+- 🚨 **Breaking Changes**: [if any]
+
+### Related
+
+- Issue: [{{ISSUE_TRACKER}} link]
+- PR: [Pull request link]
+- Complex fix docs: [Link if applicable]
+
+---
+
+## [{{YYYY-MM-DD}}] - {{ANOTHER_FIX_TITLE}}
+
+### Fixed/Changed/Added
+
+- **Issue**: Brief description of the problem
+  - **Root cause**: Why it happened
+  - **Solution**: How it was fixed
+  - **Files modified**: `path/to/file1.ext`, `path/to/file2.ext`
+  - **Status**: ✅ Fixed | ⏳ In Progress | 🔄 Under Review
+
+### Impact
+
+- 🔧 **Technical**: [Technical improvements]
+- 🎯 **User Experience**: [UX enhancements]
+- 🚨 **Breaking Changes**: [if any]
+
+### Related
+
+- Issue: [{{ISSUE_TRACKER}} link]
+- PR: [Pull request link]
+
+---
+
+## Patterns & Learnings
+
+### Common Issues Discovered
+
+- **Pattern 1**: [Description and prevention strategy]
+- **Pattern 2**: [Description and prevention strategy]
+
+### Best Practices Established
+
+- **Practice 1**: [Description]
+- **Practice 2**: [Description]
+
+### Technical Debt
+
+- [ ] **Item 1**: [Description and priority]
+- [ ] **Item 2**: [Description and priority]
+
+---
+
+**Last Updated**: {{YYYY-MM-DD}}
+**Next Review**: {{NEXT_MONTH_END}}