Skip to content

Commit 5802ca7

Browse files
Merge pull request #231 from TimeWarpEngineering/Cramer/2025-06-24/Task_025
Task 025: File Naming Convention Analysis and Standardization
2 parents 4bf7361 + d528e32 commit 5802ca7

18 files changed

Lines changed: 631 additions & 15 deletions

CLAUDE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# CLAUDE.md
1+
# Claude.md
22

33
This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
44

Lines changed: 29 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# CLAUDE.md
1+
# Claude.md
22

33
This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
44

@@ -122,6 +122,19 @@ This project uses a **hybrid approach** combining Kanban folders for internal de
122122
- `Kanban/InProgress/` - Currently being worked on
123123
- `Kanban/Done/` - Completed tasks
124124

125+
### Task Organization Convention
126+
- **Simple tasks**: Single markdown file (e.g., `001_Fix-Bug.md`)
127+
- **Complex tasks with deliverables**: Use folder structure:
128+
```
129+
025_Create-Analysis-Report/
130+
├── Task.md # Task specification and notes
131+
├── Report.md # Generated deliverable
132+
└── Additional.md # Other outputs as needed
133+
```
134+
- **Folder naming**: Same `###_Task-Name` pattern as single files
135+
- **Task file naming**: Use `Task.md` within folder (path provides context)
136+
- **Deliverable naming**: Descriptive names for outputs
137+
125138
### GitHub Issues (External Interface)
126139
- **Community contributions**: Bug reports, feature requests from users
127140
- **AI agent integration**: Create issues and mention AI agents (e.g., @claude) for automated work
@@ -134,6 +147,21 @@ This project uses a **hybrid approach** combining Kanban folders for internal de
134147
3. **AI automation**: Comment on GitHub Issues with "@claude please work on this" to trigger AI agents
135148
4. **Branch naming**: Task numbers integrate with branch naming convention: `Author/YYYY-MM-DD/Task_###`
136149

150+
### Branch Naming Convention (ADR-0004)
151+
**Format**: `Author/YYYY-MM-DD/Task_###`
152+
153+
**Examples**:
154+
- `Cramer/2025-06-18/Task_019`
155+
- `Cramer/2025-06-23/Task_023`
156+
- `Cramer/2025-06-24/Task_025`
157+
158+
**Elements**:
159+
- **Author**: Developer's name/identifier (e.g., "Cramer")
160+
- **Date**: Branch creation date in YYYY-MM-DD format
161+
- **Task**: Task number from Kanban system (###)
162+
163+
**Usage**: Always create feature branches using this convention when starting work on Kanban tasks. This provides clear ownership, temporal context, and traceability to the task management system.
164+
137165
### Definition of Done (API Endpoints)
138166
**Implementation:**
139167
- Server: *Endpoint (required), Server-side Validator, Mapper, *Handler (required)

TimeWarp.Architecture/Documentation/Developer/Conceptual/ArchitecturalDecisionRecords/Approved/0006-kanban-development-process.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -117,6 +117,19 @@ Kanban/
117117
* **Active tasks**: `001_`, `002_`, etc. (remove B prefix when ready)
118118
* **Sequential numbering**: Ensures unique identification and chronological order
119119

120+
### Task Organization Convention
121+
* **Simple tasks**: Single markdown file (e.g., `001_Fix-Bug.md`)
122+
* **Complex tasks with deliverables**: Folder structure for organization
123+
```
124+
025_Create-File-Naming-Convention-Analysis-Report/
125+
├── Task.md # Task specification and notes
126+
├── Analysis-Report.md # Generated deliverable
127+
└── Additional-Files.md # Other outputs as needed
128+
```
129+
* **Folder naming**: Use same `###_Task-Name` pattern as single files
130+
* **Task file naming**: Use `Task.md` within folder (path provides context, eliminates redundancy)
131+
* **Deliverable naming**: Descriptive names for outputs (reports, documentation, etc.)
132+
120133
### Integration with Development Workflow
121134
* **Branch naming**: Task numbers align with branch naming (e.g., `Author/Date/Task_019`)
122135
* **Commit references**: Commits can reference task numbers for traceability

TimeWarp.Architecture/Documentation/Developer/Conceptual/DirectoryStructure.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@
2929
* [Directory.Build.props](https://docs.microsoft.com/en-us/visualstudio/msbuild/customize-your-build?view=vs-2019#directorybuildprops-and-directorybuildtargets) Set the versions of the packages used across the solution here.
3030
* [global.json](https://docs.microsoft.com/en-us/dotnet/core/tools/global-json?tabs=netcore3x)- (optional) specify required SDK
3131
* [Nuget.config](https://docs.microsoft.com/en-us/nuget/reference/nuget-config-file) - specify NuGet sources
32-
* README.md
32+
* ReadMe.md
3333
* Run.ps1 - (optional) PowerShell script to Run the application
3434
* TestCafe.ps1 - Script to execute the TestCafe tests
3535
* UNLICENSE.md

TimeWarp.Architecture/Kanban/Done/023_Create-Architectural-Decision-Records.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ Create formal Architectural Decision Records (ADRs) to document key development
4848
- ✅ Used consistent terminology (master vs main branch)
4949
- ✅ Created proper branch and followed Kanban workflow
5050
- ✅ Committed changes following proper process
51-
- ✅ Updated CLAUDE.md to reference new ADRs
51+
- ✅ Updated Claude.md to reference new ADRs
5252

5353
## Related Tasks
5454

@@ -65,5 +65,5 @@ Create formal Architectural Decision Records (ADRs) to document key development
6565
2. ✅ Moved task to InProgress
6666
3. ✅ Committed ADR files on branch
6767
4. ✅ Enhanced ADRs based on feedback and comprehensive analysis
68-
5. ✅ Updated CLAUDE.md to reference new ADRs
68+
5. ✅ Updated Claude.md to reference new ADRs
6969
6. ✅ Ready for pull request creation and task completion

TimeWarp.Architecture/Kanban/Done/024_Migrate-To-Hybrid-Task-Management.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ Implement the hybrid Kanban + GitHub Issues approach documented in ADR-0006 by r
5353
### Template Clean-up
5454

5555
- Remove Process folder references from documentation
56-
- Update CLAUDE.md to reflect hybrid approach
56+
- Update Claude.md to reflect hybrid approach
5757
- Ensure new template instances only include Kanban
5858

5959
## Related Work

0 commit comments

Comments
 (0)