toolz/goplt
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: add implementation plan, ADRs, and task tracking system

Browse Source 
- Add comprehensive 8-phase implementation plan (docs/plan.md)
- Add 28 Architecture Decision Records (docs/adr/) covering all phases
- Add task tracking system with 283+ task files (docs/stories/)
- Add task generator script for automated task file creation
- Add reference playbooks and requirements documentation

This commit establishes the complete planning foundation for the Go
Platform implementation, documenting all architectural decisions and
providing detailed task breakdown for Phases 0-8.
This commit is contained in:
0x1d
2025-11-04 22:02:50 +01:00
commit 6a17236474
329 changed files with 16858 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

58
docs/stories/phase4/4.1.1-create-modulesblog-directory.md Normal file
View File

@@ -0,0 +1,58 @@
# Task 4.1.1: Create `modules/blog/` directory:
## Metadata
- **Task ID**: 4.1.1
- **Title**: Create `modules/blog/` directory:
- **Phase**: 4 - Sample Feature Module (Blog)
- **Section**: 4.1
- **Status**: Pending
- **Priority**: High
- **Estimated Time**: TBD
- **Dependencies**: TBD
## Description
Create `modules/blog/` directory:
## Requirements
- Create `modules/blog/` directory:
## Implementation Steps
1. TODO: Add implementation steps
2. TODO: Add implementation steps
3. TODO: Add implementation steps
## Acceptance Criteria
- [ ] Task 4.1.1 is completed
- [ ] All requirements are met
- [ ] Code compiles and tests pass
## Related ADRs
- See relevant ADRs in `docs/adr/`
## Implementation Notes
- TODO: Add implementation notes
## Testing
```bash
# TODO: Add test commands
go test ./...
```
## Code Reference
```go
modules/blog/
├── go.mod
├── module.yaml
├── internal/
│ ├── api/
│ │ └── handler.go
│ ├── domain/
│ │ ├── post.go
│ │ └── post_repo.go
│ └── service/
│ └── post_service.go
└── pkg/
└── module.go
```

47
docs/stories/phase4/4.1.2-initialize-gomod.md Normal file
View File

@@ -0,0 +1,47 @@
# Task 4.1.2: Initialize `go.mod`:
## Metadata
- **Task ID**: 4.1.2
- **Title**: Initialize `go.mod`:
- **Phase**: 4 - Sample Feature Module (Blog)
- **Section**: 4.1
- **Status**: Pending
- **Priority**: High
- **Estimated Time**: TBD
- **Dependencies**: TBD
## Description
Initialize `go.mod`:
## Requirements
- Initialize `go.mod`:
## Implementation Steps
1. TODO: Add implementation steps
2. TODO: Add implementation steps
3. TODO: Add implementation steps
## Acceptance Criteria
- [ ] Task 4.1.2 is completed
- [ ] All requirements are met
- [ ] Code compiles and tests pass
## Related ADRs
- See relevant ADRs in `docs/adr/`
## Implementation Notes
- TODO: Add implementation notes
## Testing
```bash
# TODO: Add test commands
go test ./...
```
## Code Reference
```go
cd modules/blog
go mod init github.com/yourorg/blog
```

70
docs/stories/phase4/4.2.1-create-modulesblogmoduleyaml.md Normal file
View File

@@ -0,0 +1,70 @@
# Task 4.2.1: Create `modules/blog/module.yaml`:
## Metadata
- **Task ID**: 4.2.1
- **Title**: Create `modules/blog/module.yaml`:
- **Phase**: 4 - Sample Feature Module (Blog)
- **Section**: 4.2
- **Status**: Pending
- **Priority**: High
- **Estimated Time**: TBD
- **Dependencies**: TBD
## Description
Create `modules/blog/module.yaml`:
## Requirements
- Create `modules/blog/module.yaml`:
## Implementation Steps
1. TODO: Add implementation steps
2. TODO: Add implementation steps
3. TODO: Add implementation steps
## Acceptance Criteria
- [ ] Task 4.2.1 is completed
- [ ] All requirements are met
- [ ] Code compiles and tests pass
## Related ADRs
- See relevant ADRs in `docs/adr/`
## Implementation Notes
- TODO: Add implementation notes
## Testing
```bash
# TODO: Add test commands
go test ./...
```
## Code Reference
```go
name: blog
version: 0.1.0
dependencies:
- core >= 1.0.0
permissions:
- blog.post.create
- blog.post.read
- blog.post.update
- blog.post.delete
routes:
- method: POST
path: /api/v1/blog/posts
permission: blog.post.create
- method: GET
path: /api/v1/blog/posts/:id
permission: blog.post.read
- method: PUT
path: /api/v1/blog/posts/:id
permission: blog.post.update
- method: DELETE
path: /api/v1/blog/posts/:id
permission: blog.post.delete
- method: GET
path: /api/v1/blog/posts
permission: blog.post.read
```

53
docs/stories/phase4/4.3.1-create-modulesbloginternaldomainpostgo.md Normal file
View File

@@ -0,0 +1,53 @@
# Task 4.3.1: Create `modules/blog/internal/domain/post.go`:
## Metadata
- **Task ID**: 4.3.1
- **Title**: Create `modules/blog/internal/domain/post.go`:
- **Phase**: 4 - Sample Feature Module (Blog)
- **Section**: 4.3
- **Status**: Pending
- **Priority**: High
- **Estimated Time**: TBD
- **Dependencies**: TBD
## Description
Create `modules/blog/internal/domain/post.go`:
## Requirements
- Create `modules/blog/internal/domain/post.go`:
## Implementation Steps
1. TODO: Add implementation steps
2. TODO: Add implementation steps
3. TODO: Add implementation steps
## Acceptance Criteria
- [ ] Task 4.3.1 is completed
- [ ] All requirements are met
- [ ] Code compiles and tests pass
## Related ADRs
- See relevant ADRs in `docs/adr/`
## Implementation Notes
- TODO: Add implementation notes
## Testing
```bash
# TODO: Add test commands
go test ./...
```
## Code Reference
```go
type Post struct {
ID string
Title string
Content string
AuthorID string
CreatedAt time.Time
UpdatedAt time.Time
}
```

40
docs/stories/phase4/4.3.2-create-ent-schema-modulesbloginternalentschemapost.md Normal file
View File

@@ -0,0 +1,40 @@
# Task 4.3.2: Create Ent schema `modules/blog/internal/ent/schema/post.go`:
## Metadata
- **Task ID**: 4.3.2
- **Title**: Create Ent schema `modules/blog/internal/ent/schema/post.go`:
- **Phase**: 4 - Sample Feature Module (Blog)
- **Section**: 4.3
- **Status**: Pending
- **Priority**: High
- **Estimated Time**: TBD
- **Dependencies**: TBD
## Description
Create Ent schema `modules/blog/internal/ent/schema/post.go`:
## Requirements
- Create Ent schema `modules/blog/internal/ent/schema/post.go`:
## Implementation Steps
1. TODO: Add implementation steps
2. TODO: Add implementation steps
3. TODO: Add implementation steps
## Acceptance Criteria
- [ ] Task 4.3.2 is completed
- [ ] All requirements are met
- [ ] Code compiles and tests pass
## Related ADRs
- See relevant ADRs in `docs/adr/`
## Implementation Notes
- TODO: Add implementation notes
## Testing
```bash
# TODO: Add test commands
go test ./...
```

40
docs/stories/phase4/4.3.3-generate-ent-code-for-blog-module.md Normal file
View File

@@ -0,0 +1,40 @@
# Task 4.3.3: Generate Ent code for blog module
## Metadata
- **Task ID**: 4.3.3
- **Title**: Generate Ent code for blog module
- **Phase**: 4 - Sample Feature Module (Blog)
- **Section**: 4.3
- **Status**: Pending
- **Priority**: High
- **Estimated Time**: TBD
- **Dependencies**: TBD
## Description
Generate Ent code for blog module
## Requirements
- Generate Ent code for blog module
## Implementation Steps
1. TODO: Add implementation steps
2. TODO: Add implementation steps
3. TODO: Add implementation steps
## Acceptance Criteria
- [ ] Task 4.3.3 is completed
- [ ] All requirements are met
- [ ] Code compiles and tests pass
## Related ADRs
- See relevant ADRs in `docs/adr/`
## Implementation Notes
- TODO: Add implementation notes
## Testing
```bash
# TODO: Add test commands
go test ./...
```

52
docs/stories/phase4/4.4.1-create-modulesbloginternaldomainpost_repogo.md Normal file
View File

@@ -0,0 +1,52 @@
# Task 4.4.1: Create `modules/blog/internal/domain/post_repo.go`:
## Metadata
- **Task ID**: 4.4.1
- **Title**: Create `modules/blog/internal/domain/post_repo.go`:
- **Phase**: 4 - Sample Feature Module (Blog)
- **Section**: 4.4
- **Status**: Pending
- **Priority**: High
- **Estimated Time**: TBD
- **Dependencies**: TBD
## Description
Create `modules/blog/internal/domain/post_repo.go`:
## Requirements
- Create `modules/blog/internal/domain/post_repo.go`:
## Implementation Steps
1. TODO: Add implementation steps
2. TODO: Add implementation steps
3. TODO: Add implementation steps
## Acceptance Criteria
- [ ] Task 4.4.1 is completed
- [ ] All requirements are met
- [ ] Code compiles and tests pass
## Related ADRs
- See relevant ADRs in `docs/adr/`
## Implementation Notes
- TODO: Add implementation notes
## Testing
```bash
# TODO: Add test commands
go test ./...
```
## Code Reference
```go
type PostRepository interface {
Create(ctx context.Context, p *Post) (*Post, error)
FindByID(ctx context.Context, id string) (*Post, error)
FindByAuthor(ctx context.Context, authorID string) ([]*Post, error)
Update(ctx context.Context, p *Post) error
Delete(ctx context.Context, id string) error
}
```

40
docs/stories/phase4/4.4.2-implement-using-ent-client-shared-from-core.md Normal file
View File

@@ -0,0 +1,40 @@
# Task 4.4.2: Implement using Ent client (shared from core)
## Metadata
- **Task ID**: 4.4.2
- **Title**: Implement using Ent client (shared from core)
- **Phase**: 4 - Sample Feature Module (Blog)
- **Section**: 4.4
- **Status**: Pending
- **Priority**: High
- **Estimated Time**: TBD
- **Dependencies**: TBD
## Description
Implement using Ent client (shared from core)
## Requirements
- Implement using Ent client (shared from core)
## Implementation Steps
1. TODO: Add implementation steps
2. TODO: Add implementation steps
3. TODO: Add implementation steps
## Acceptance Criteria
- [ ] Task 4.4.2 is completed
- [ ] All requirements are met
- [ ] Code compiles and tests pass
## Related ADRs
- See relevant ADRs in `docs/adr/`
## Implementation Notes
- TODO: Add implementation notes
## Testing
```bash
# TODO: Add test commands
go test ./...
```

40
docs/stories/phase4/4.5.1-create-modulesbloginternalservicepost_servicego.md Normal file
View File

@@ -0,0 +1,40 @@
# Task 4.5.1: Create `modules/blog/internal/service/post_service.go`:
## Metadata
- **Task ID**: 4.5.1
- **Title**: Create `modules/blog/internal/service/post_service.go`:
- **Phase**: 4 - Sample Feature Module (Blog)
- **Section**: 4.5
- **Status**: Pending
- **Priority**: High
- **Estimated Time**: TBD
- **Dependencies**: TBD
## Description
Create `modules/blog/internal/service/post_service.go`:
## Requirements
- Create `modules/blog/internal/service/post_service.go`:
## Implementation Steps
1. TODO: Add implementation steps
2. TODO: Add implementation steps
3. TODO: Add implementation steps
## Acceptance Criteria
- [ ] Task 4.5.1 is completed
- [ ] All requirements are met
- [ ] Code compiles and tests pass
## Related ADRs
- See relevant ADRs in `docs/adr/`
## Implementation Notes
- TODO: Add implementation notes
## Testing
```bash
# TODO: Add test commands
go test ./...
```

40
docs/stories/phase4/4.6.1-create-modulesbloginternalapihandlergo.md Normal file
View File

@@ -0,0 +1,40 @@
# Task 4.6.1: Create `modules/blog/internal/api/handler.go`:
## Metadata
- **Task ID**: 4.6.1
- **Title**: Create `modules/blog/internal/api/handler.go`:
- **Phase**: 4 - Sample Feature Module (Blog)
- **Section**: 4.6
- **Status**: Pending
- **Priority**: High
- **Estimated Time**: TBD
- **Dependencies**: TBD
## Description
Create `modules/blog/internal/api/handler.go`:
## Requirements
- Create `modules/blog/internal/api/handler.go`:
## Implementation Steps
1. TODO: Add implementation steps
2. TODO: Add implementation steps
3. TODO: Add implementation steps
## Acceptance Criteria
- [ ] Task 4.6.1 is completed
- [ ] All requirements are met
- [ ] Code compiles and tests pass
## Related ADRs
- See relevant ADRs in `docs/adr/`
## Implementation Notes
- TODO: Add implementation notes
## Testing
```bash
# TODO: Add test commands
go test ./...
```

46
docs/stories/phase4/4.6.2-use-authorization-middleware.md Normal file
View File

@@ -0,0 +1,46 @@
# Task 4.6.2: Use authorization middleware:
## Metadata
- **Task ID**: 4.6.2
- **Title**: Use authorization middleware:
- **Phase**: 4 - Sample Feature Module (Blog)
- **Section**: 4.6
- **Status**: Pending
- **Priority**: High
- **Estimated Time**: TBD
- **Dependencies**: TBD
## Description
Use authorization middleware:
## Requirements
- Use authorization middleware:
## Implementation Steps
1. TODO: Add implementation steps
2. TODO: Add implementation steps
3. TODO: Add implementation steps
## Acceptance Criteria
- [ ] Task 4.6.2 is completed
- [ ] All requirements are met
- [ ] Code compiles and tests pass
## Related ADRs
- See relevant ADRs in `docs/adr/`
## Implementation Notes
- TODO: Add implementation notes
## Testing
```bash
# TODO: Add test commands
go test ./...
```
## Code Reference
```go
grp.Use(auth.RequirePermission(perm.BlogPostCreate))
```

40
docs/stories/phase4/4.6.3-register-handlers-in-modules-init.md Normal file
View File

@@ -0,0 +1,40 @@
# Task 4.6.3: Register handlers in module's `Init()`
## Metadata
- **Task ID**: 4.6.3
- **Title**: Register handlers in module's `Init()`
- **Phase**: 4 - Sample Feature Module (Blog)
- **Section**: 4.6
- **Status**: Pending
- **Priority**: High
- **Estimated Time**: TBD
- **Dependencies**: TBD
## Description
Register handlers in module's `Init()`
## Requirements
- Register handlers in module's `Init()`
## Implementation Steps
1. TODO: Add implementation steps
2. TODO: Add implementation steps
3. TODO: Add implementation steps
## Acceptance Criteria
- [ ] Task 4.6.3 is completed
- [ ] All requirements are met
- [ ] Code compiles and tests pass
## Related ADRs
- See relevant ADRs in `docs/adr/`
## Implementation Notes
- TODO: Add implementation notes
## Testing
```bash
# TODO: Add test commands
go test ./...
```

70
docs/stories/phase4/4.7.1-create-modulesblogpkgmodulego.md Normal file
View File

@@ -0,0 +1,70 @@
# Task 4.7.1: Create `modules/blog/pkg/module.go`:
## Metadata
- **Task ID**: 4.7.1
- **Title**: Create `modules/blog/pkg/module.go`:
- **Phase**: 4 - Sample Feature Module (Blog)
- **Section**: 4.7
- **Status**: Pending
- **Priority**: High
- **Estimated Time**: TBD
- **Dependencies**: TBD
## Description
Create `modules/blog/pkg/module.go`:
## Requirements
- Create `modules/blog/pkg/module.go`:
## Implementation Steps
1. TODO: Add implementation steps
2. TODO: Add implementation steps
3. TODO: Add implementation steps
## Acceptance Criteria
- [ ] Task 4.7.1 is completed
- [ ] All requirements are met
- [ ] Code compiles and tests pass
## Related ADRs
- See relevant ADRs in `docs/adr/`
## Implementation Notes
- TODO: Add implementation notes
## Testing
```bash
# TODO: Add test commands
go test ./...
```
## Code Reference
```go
type BlogModule struct{}
func (b BlogModule) Name() string { return "blog" }
func (b BlogModule) Version() string { return "0.1.0" }
func (b BlogModule) Dependencies() []string { return nil }
func (b BlogModule) Init() fx.Option {
return fx.Options(
fx.Provide(NewPostRepo),
fx.Provide(NewPostService),
fx.Invoke(RegisterHandlers),
)
}
func (b BlogModule) Migrations() []func(*ent.Client) error {
return []func(*ent.Client) error{
func(c *ent.Client) error {
return c.Schema.Create(context.Background())
},
}
}
var Module BlogModule
func init() {
registry.Register(Module)
}
```

46
docs/stories/phase4/4.8.1-update-main-gomod-to-include-blog-module.md Normal file
View File

@@ -0,0 +1,46 @@
# Task 4.8.1: Update main `go.mod` to include blog module:
## Metadata
- **Task ID**: 4.8.1
- **Title**: Update main `go.mod` to include blog module:
- **Phase**: 4 - Sample Feature Module (Blog)
- **Section**: 4.8
- **Status**: Pending
- **Priority**: High
- **Estimated Time**: TBD
- **Dependencies**: TBD
## Description
Update main `go.mod` to include blog module:
## Requirements
- Update main `go.mod` to include blog module:
## Implementation Steps
1. TODO: Add implementation steps
2. TODO: Add implementation steps
3. TODO: Add implementation steps
## Acceptance Criteria
- [ ] Task 4.8.1 is completed
- [ ] All requirements are met
- [ ] Code compiles and tests pass
## Related ADRs
- See relevant ADRs in `docs/adr/`
## Implementation Notes
- TODO: Add implementation notes
## Testing
```bash
# TODO: Add test commands
go test ./...
```
## Code Reference
```go
replace github.com/yourorg/blog => ./modules/blog
```

46
docs/stories/phase4/4.8.2-import-blog-module-in-cmdplatformmaingo.md Normal file
View File

@@ -0,0 +1,46 @@
# Task 4.8.2: Import blog module in `cmd/platform/main.go`:
## Metadata
- **Task ID**: 4.8.2
- **Title**: Import blog module in `cmd/platform/main.go`:
- **Phase**: 4 - Sample Feature Module (Blog)
- **Section**: 4.8
- **Status**: Pending
- **Priority**: High
- **Estimated Time**: TBD
- **Dependencies**: TBD
## Description
Import blog module in `cmd/platform/main.go`:
## Requirements
- Import blog module in `cmd/platform/main.go`:
## Implementation Steps
1. TODO: Add implementation steps
2. TODO: Add implementation steps
3. TODO: Add implementation steps
## Acceptance Criteria
- [ ] Task 4.8.2 is completed
- [ ] All requirements are met
- [ ] Code compiles and tests pass
## Related ADRs
- See relevant ADRs in `docs/adr/`
## Implementation Notes
- TODO: Add implementation notes
## Testing
```bash
# TODO: Add test commands
go test ./...
```
## Code Reference
```go
import _ "github.com/yourorg/blog/pkg"
```

40
docs/stories/phase4/4.8.3-run-permission-generation-make-generate.md Normal file
View File

@@ -0,0 +1,40 @@
# Task 4.8.3: Run permission generation: `make generate`
## Metadata
- **Task ID**: 4.8.3
- **Title**: Run permission generation: `make generate`
- **Phase**: 4 - Sample Feature Module (Blog)
- **Section**: 4.8
- **Status**: Pending
- **Priority**: High
- **Estimated Time**: TBD
- **Dependencies**: TBD
## Description
Run permission generation: `make generate`
## Requirements
- Run permission generation: `make generate`
## Implementation Steps
1. TODO: Add implementation steps
2. TODO: Add implementation steps
3. TODO: Add implementation steps
## Acceptance Criteria
- [ ] Task 4.8.3 is completed
- [ ] All requirements are met
- [ ] Code compiles and tests pass
## Related ADRs
- See relevant ADRs in `docs/adr/`
## Implementation Notes
- TODO: Add implementation notes
## Testing
```bash
# TODO: Add test commands
go test ./...
```

40
docs/stories/phase4/4.8.4-verify-blog-permissions-are-generated.md Normal file
View File

@@ -0,0 +1,40 @@
# Task 4.8.4: Verify blog permissions are generated
## Metadata
- **Task ID**: 4.8.4
- **Title**: Verify blog permissions are generated
- **Phase**: 4 - Sample Feature Module (Blog)
- **Section**: 4.8
- **Status**: Pending
- **Priority**: High
- **Estimated Time**: TBD
- **Dependencies**: TBD
## Description
Verify blog permissions are generated
## Requirements
- Verify blog permissions are generated
## Implementation Steps
1. TODO: Add implementation steps
2. TODO: Add implementation steps
3. TODO: Add implementation steps
## Acceptance Criteria
- [ ] Task 4.8.4 is completed
- [ ] All requirements are met
- [ ] Code compiles and tests pass
## Related ADRs
- See relevant ADRs in `docs/adr/`
## Implementation Notes
- TODO: Add implementation notes
## Testing
```bash
# TODO: Add test commands
go test ./...
```

40
docs/stories/phase4/4.9.1-create-integration-test-modulesbloginternalapihand.md Normal file
View File

@@ -0,0 +1,40 @@
# Task 4.9.1: Create integration test `modules/blog/internal/api/handler_test.go`:
## Metadata
- **Task ID**: 4.9.1
- **Title**: Create integration test `modules/blog/internal/api/handler_test.go`:
- **Phase**: 4 - Sample Feature Module (Blog)
- **Section**: 4.9
- **Status**: Pending
- **Priority**: High
- **Estimated Time**: TBD
- **Dependencies**: TBD
## Description
Create integration test `modules/blog/internal/api/handler_test.go`:
## Requirements
- Create integration test `modules/blog/internal/api/handler_test.go`:
## Implementation Steps
1. TODO: Add implementation steps
2. TODO: Add implementation steps
3. TODO: Add implementation steps
## Acceptance Criteria
- [ ] Task 4.9.1 is completed
- [ ] All requirements are met
- [ ] Code compiles and tests pass
## Related ADRs
- See relevant ADRs in `docs/adr/`
## Implementation Notes
- TODO: Add implementation notes
## Testing
```bash
# TODO: Add test commands
go test ./...
```

40
docs/stories/phase4/4.9.2-add-unit-tests-for-service-and-repository.md Normal file
View File

@@ -0,0 +1,40 @@
# Task 4.9.2: Add unit tests for service and repository
## Metadata
- **Task ID**: 4.9.2
- **Title**: Add unit tests for service and repository
- **Phase**: 4 - Sample Feature Module (Blog)
- **Section**: 4.9
- **Status**: Pending
- **Priority**: High
- **Estimated Time**: TBD
- **Dependencies**: TBD
## Description
Add unit tests for service and repository
## Requirements
- Add unit tests for service and repository
## Implementation Steps
1. TODO: Add implementation steps
2. TODO: Add implementation steps
3. TODO: Add implementation steps
## Acceptance Criteria
- [ ] Task 4.9.2 is completed
- [ ] All requirements are met
- [ ] Code compiles and tests pass
## Related ADRs
- See relevant ADRs in `docs/adr/`
## Implementation Notes
- TODO: Add implementation notes
## Testing
```bash
# TODO: Add test commands
go test ./...
```