Skip to content

Commit d528e32

Browse files
StevenTCramerclaude
StevenTCramer
and
claude
committed
Create Kanban tasks for file naming convention implementation phases
* Task 026: Fix Critical Kanban Inconsistencies (Phase 1 - 1 day) - Fix 4 identified naming inconsistencies in Kanban files - Resolve duplicate task numbers and case inconsistencies - Low risk, immediate priority fixes * Task 027: Create File Naming Convention ADR And Documentation (Phase 2 - 2 days) - Create comprehensive ADR-0007 for file naming conventions - Update Task Template with naming guidelines - Document technology-specific patterns and examples * Task 028: Implement Automated Naming Convention Checks (Phase 3 - 3 days) - Create pre-commit hooks for naming validation - Add CI/CD naming convention tests - Implement migration scripts and compliance monitoring These tasks implement the Implementation Timeline from Task 025 analysis report, providing systematic approach to achieving 100% naming convention compliance. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
1 parent 0d8c246 commit d528e32

3 files changed

Lines changed: 201 additions & 0 deletions

File tree

‎TimeWarp.Architecture/Kanban/ToDo/026_Fix-Critical-Kanban-Inconsistencies.md‎

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
# 026: Fix Critical Kanban Inconsistencies
2+
3+
## Description
4+
5+
Fix the 4 critical naming inconsistencies identified in the file naming convention analysis report to achieve consistent PascalCase naming across all Kanban task files.
6+
7+
## Parent
8+
9+
025_Create-File-Naming-Convention-Analysis-Report
10+
11+
## Requirements
12+
13+
- Fix all 4 identified Kanban naming inconsistencies
14+
- Preserve git history using `git mv` for renames
15+
- Update any references to renamed files
16+
- Maintain task numbering uniqueness
17+
18+
## Checklist
19+
20+
### Critical Issues to Fix
21+
- [ ] Fix sub-task case inconsistency (3 files):
22+
- [ ] `004_001_convert-weatherforecast-to-fastendpoints.md` → `004_001_Convert-WeatherForecast-To-FastEndpoints.md`
23+
- [ ] `004_002_remove-mediatr-from-api.md` → `004_002_Remove-MediatR-From-Api.md`
24+
- [ ] `004_003_implement-openapi-and-scalar.md` → `004_003_Implement-OpenApi-And-Scalar.md`
25+
26+
### Duplicate Task Numbers
27+
- [ ] Resolve duplicate task numbers:
28+
- [ ] Keep `001_Fix-FastEndpointSourceGenerator.md`
29+
- [ ] Rename `001_NavLink-Encapsulation-Implementation.md` to next available number
30+
- [ ] Update any cross-references to the renumbered task
31+
32+
### Single Lowercase Exception
33+
- [ ] Fix main task case inconsistency:
34+
- [ ] `004_migrate-api-to-fastendpoints.md` → `004_Migrate-Api-To-FastEndpoints.md`
35+
36+
### Verification
37+
- [ ] Verify all Kanban task files use proper PascalCase naming
38+
- [ ] Confirm no duplicate task numbers exist
39+
- [ ] Test that all references still work correctly
40+
- [ ] Update analysis report if needed
41+
42+
## Notes
43+
44+
This is Phase 1 of the Implementation Timeline from the file naming convention analysis. Should be completed in 1 day with low risk as it only affects Kanban folder organization.
45+
46+
**Priority**: High - These inconsistencies break the established naming conventions and should be fixed immediately.
47+
48+
**Risk Level**: Low - File renames in Kanban folder with no impact on source code.
49+
50+
## Implementation Notes
51+
52+
[To be updated during task execution]

‎TimeWarp.Architecture/Kanban/ToDo/027_Create-File-Naming-Convention-ADR-And-Documentation.md‎

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
# 027: Create File Naming Convention ADR And Documentation
2+
3+
## Description
4+
5+
Create a comprehensive Architectural Decision Record (ADR) for file naming conventions and update associated documentation to establish standardized patterns across the TimeWarp.Architecture project.
6+
7+
## Parent
8+
9+
025_Create-File-Naming-Convention-Analysis-Report
10+
11+
## Requirements
12+
13+
- Create ADR documenting all established file naming patterns
14+
- Include technology-specific conventions for each file type
15+
- Provide clear examples for each naming pattern
16+
- Update Task Template with naming convention guidelines
17+
- Document infrastructure naming standards
18+
19+
## Checklist
20+
21+
### ADR Creation
22+
- [ ] Create ADR-0007 (or next available number) for file naming conventions
23+
- [ ] Document C# source file naming patterns (PascalCase.cs)
24+
- [ ] Document Razor component naming patterns (PascalCase.razor, Parent_Child.razor)
25+
- [ ] Document configuration file patterns (lowercase.json, .dotfile.js)
26+
- [ ] Document infrastructure file patterns (bicep, kubernetes, powershell)
27+
- [ ] Document Kanban task file patterns (###_Title-With-Hyphens.md)
28+
- [ ] Include technology-specific examples for each category
29+
30+
### Task Template Updates
31+
- [ ] Add naming convention guidelines section to Task-Template.md
32+
- [ ] Include examples of proper task naming
33+
- [ ] Document sub-task numbering rules (###_###_ pattern)
34+
- [ ] Add folder vs single file decision criteria
35+
36+
### Infrastructure Standards Documentation
37+
- [ ] Clarify Kubernetes YAML naming conventions (snake_case + hyphens)
38+
- [ ] Document when to use snake_case vs kebab-case
39+
- [ ] Standardize multi-word file handling across technologies
40+
- [ ] Create examples for Bicep file naming
41+
42+
### Integration with Existing ADRs
43+
- [ ] Reference ADR-0006 (Kanban process) for task naming
44+
- [ ] Cross-reference with branch naming conventions (ADR-0004)
45+
- [ ] Ensure consistency with existing architectural decisions
46+
47+
### Documentation Updates
48+
- [ ] Update relevant documentation files that reference naming patterns
49+
- [ ] Add links to new ADR from appropriate locations
50+
- [ ] Verify all examples follow established conventions
51+
52+
## Notes
53+
54+
This is Phase 2 of the Implementation Timeline from the file naming convention analysis. Estimated completion time: 2 days.
55+
56+
**Builds on**: Task 026 (critical fixes should be completed first)
57+
58+
**Benefits**:
59+
- Establishes official naming standards for future development
60+
- Provides clear guidance for developers and AI assistants
61+
- Ensures consistency across all file types and technologies
62+
63+
## Implementation Notes
64+
65+
[To be updated during task execution]

‎TimeWarp.Architecture/Kanban/ToDo/028_Implement-Automated-Naming-Convention-Checks.md‎

Lines changed: 84 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,84 @@
1+
# 028: Implement Automated Naming Convention Checks
2+
3+
## Description
4+
5+
Implement automated validation and checks for file naming conventions to prevent future inconsistencies and maintain high compliance rates across the TimeWarp.Architecture project.
6+
7+
## Parent
8+
9+
025_Create-File-Naming-Convention-Analysis-Report
10+
11+
## Requirements
12+
13+
- Create pre-commit hooks for task naming validation
14+
- Add naming convention tests to CI/CD pipeline
15+
- Implement task number uniqueness validation
16+
- Create migration scripts for future file renames
17+
- Establish monitoring for naming convention compliance
18+
19+
## Checklist
20+
21+
### Pre-commit Hooks
22+
- [ ] Create PowerShell script to validate Kanban task naming patterns
23+
- [ ] Implement PascalCase validation for task titles
24+
- [ ] Add task number uniqueness checking
25+
- [ ] Validate proper ###_Title-With-Hyphens.md format
26+
- [ ] Check for duplicate task numbers across all Kanban folders
27+
- [ ] Integrate with git pre-commit hooks
28+
29+
### CI/CD Integration
30+
- [ ] Add naming convention tests to GitHub Actions workflow
31+
- [ ] Create automated checks for C# file naming (PascalCase.cs)
32+
- [ ] Validate Razor component naming patterns
33+
- [ ] Check infrastructure file naming compliance
34+
- [ ] Generate compliance reports on each build
35+
36+
### Migration and Maintenance Scripts
37+
- [ ] Create PowerShell script to rename non-compliant files
38+
- [ ] Implement Git history preservation during renames (`git mv`)
39+
- [ ] Add script to update all references to renamed files
40+
- [ ] Create task number conflict resolution script
41+
- [ ] Develop bulk naming pattern correction tools
42+
43+
### Validation Rules Implementation
44+
- [ ] C# files: Strict PascalCase validation
45+
- [ ] Razor components: PascalCase with underscore sub-components
46+
- [ ] Configuration files: Technology-appropriate casing
47+
- [ ] Kanban tasks: PascalCase titles with hyphen separators
48+
- [ ] Infrastructure files: Documented standard compliance
49+
50+
### Monitoring and Reporting
51+
- [ ] Create compliance dashboard/report generation
52+
- [ ] Implement metrics collection for naming consistency
53+
- [ ] Add alerts for naming convention violations
54+
- [ ] Generate periodic compliance assessment reports
55+
56+
### Documentation
57+
- [ ] Document how to use validation scripts
58+
- [ ] Create troubleshooting guide for naming issues
59+
- [ ] Document CI/CD integration setup
60+
- [ ] Provide examples of automated fixes
61+
62+
## Notes
63+
64+
This is Phase 3 of the Implementation Timeline from the file naming convention analysis. Estimated completion time: 3 days.
65+
66+
**Dependencies**:
67+
- Task 026 (critical fixes) should be completed first
68+
- Task 027 (ADR documentation) provides the standards to validate against
69+
70+
**Benefits**:
71+
- Prevents future naming inconsistencies
72+
- Maintains 99%+ compliance rate automatically
73+
- Reduces manual review overhead
74+
- Provides immediate feedback to developers
75+
76+
**Technical Considerations**:
77+
- Scripts should be cross-platform compatible (PowerShell Core)
78+
- CI/CD checks should be fast and non-blocking for valid names
79+
- Migration scripts must preserve git history
80+
- Validation rules should be configurable and extensible
81+
82+
## Implementation Notes
83+
84+
[To be updated during task execution]

0 commit comments

Comments
 (0)