docs: add mkdocs, update links, add architecture documentation
This commit is contained in:
@@ -0,0 +1,40 @@
|
||||
# Task 7.1.1: Achieve >80% code coverage for core modules:
|
||||
|
||||
## Metadata
|
||||
- **Task ID**: 7.1.1
|
||||
- **Title**: Achieve >80% code coverage for core modules:
|
||||
- **Phase**: 7 - Testing, Documentation & CI/CD
|
||||
- **Section**: 7.1
|
||||
- **Status**: Pending
|
||||
- **Priority**: High
|
||||
- **Estimated Time**: TBD
|
||||
- **Dependencies**: TBD
|
||||
|
||||
## Description
|
||||
Achieve >80% code coverage for core modules:
|
||||
|
||||
## Requirements
|
||||
- Achieve >80% code coverage for core modules:
|
||||
|
||||
## Implementation Steps
|
||||
1. TODO: Add implementation steps
|
||||
2. TODO: Add implementation steps
|
||||
3. TODO: Add implementation steps
|
||||
|
||||
## Acceptance Criteria
|
||||
- [ ] Task 7.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 ./...
|
||||
```
|
||||
|
||||
@@ -0,0 +1,40 @@
|
||||
# Task 7.1.2: Use `github.com/stretchr/testify` for assertions
|
||||
|
||||
## Metadata
|
||||
- **Task ID**: 7.1.2
|
||||
- **Title**: Use `github.com/stretchr/testify` for assertions
|
||||
- **Phase**: 7 - Testing, Documentation & CI/CD
|
||||
- **Section**: 7.1
|
||||
- **Status**: Pending
|
||||
- **Priority**: High
|
||||
- **Estimated Time**: TBD
|
||||
- **Dependencies**: TBD
|
||||
|
||||
## Description
|
||||
Use `github.com/stretchr/testify` for assertions
|
||||
|
||||
## Requirements
|
||||
- Use `github.com/stretchr/testify` for assertions
|
||||
|
||||
## Implementation Steps
|
||||
1. TODO: Add implementation steps
|
||||
2. TODO: Add implementation steps
|
||||
3. TODO: Add implementation steps
|
||||
|
||||
## Acceptance Criteria
|
||||
- [ ] Task 7.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 ./...
|
||||
```
|
||||
|
||||
@@ -0,0 +1,40 @@
|
||||
# Task 7.1.3: Use `github.com/golang/mock` or `mockery` for mocks
|
||||
|
||||
## Metadata
|
||||
- **Task ID**: 7.1.3
|
||||
- **Title**: Use `github.com/golang/mock` or `mockery` for mocks
|
||||
- **Phase**: 7 - Testing, Documentation & CI/CD
|
||||
- **Section**: 7.1
|
||||
- **Status**: Pending
|
||||
- **Priority**: High
|
||||
- **Estimated Time**: TBD
|
||||
- **Dependencies**: TBD
|
||||
|
||||
## Description
|
||||
Use `github.com/golang/mock` or `mockery` for mocks
|
||||
|
||||
## Requirements
|
||||
- Use `github.com/golang/mock` or `mockery` for mocks
|
||||
|
||||
## Implementation Steps
|
||||
1. TODO: Add implementation steps
|
||||
2. TODO: Add implementation steps
|
||||
3. TODO: Add implementation steps
|
||||
|
||||
## Acceptance Criteria
|
||||
- [ ] Task 7.1.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/content/stories/phase7/7.1.4-add-test-helpers.md
Normal file
40
docs/content/stories/phase7/7.1.4-add-test-helpers.md
Normal file
@@ -0,0 +1,40 @@
|
||||
# Task 7.1.4: Add test helpers:
|
||||
|
||||
## Metadata
|
||||
- **Task ID**: 7.1.4
|
||||
- **Title**: Add test helpers:
|
||||
- **Phase**: 7 - Testing, Documentation & CI/CD
|
||||
- **Section**: 7.1
|
||||
- **Status**: Pending
|
||||
- **Priority**: High
|
||||
- **Estimated Time**: TBD
|
||||
- **Dependencies**: TBD
|
||||
|
||||
## Description
|
||||
Add test helpers:
|
||||
|
||||
## Requirements
|
||||
- Add test helpers:
|
||||
|
||||
## Implementation Steps
|
||||
1. TODO: Add implementation steps
|
||||
2. TODO: Add implementation steps
|
||||
3. TODO: Add implementation steps
|
||||
|
||||
## Acceptance Criteria
|
||||
- [ ] Task 7.1.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 ./...
|
||||
```
|
||||
|
||||
@@ -0,0 +1,40 @@
|
||||
# Task 7.2.1: Install `github.com/testcontainers/testcontainers-go`
|
||||
|
||||
## Metadata
|
||||
- **Task ID**: 7.2.1
|
||||
- **Title**: Install `github.com/testcontainers/testcontainers-go`
|
||||
- **Phase**: 7 - Testing, Documentation & CI/CD
|
||||
- **Section**: 7.2
|
||||
- **Status**: Pending
|
||||
- **Priority**: High
|
||||
- **Estimated Time**: TBD
|
||||
- **Dependencies**: TBD
|
||||
|
||||
## Description
|
||||
Install `github.com/testcontainers/testcontainers-go`
|
||||
|
||||
## Requirements
|
||||
- Install `github.com/testcontainers/testcontainers-go`
|
||||
|
||||
## Implementation Steps
|
||||
1. TODO: Add implementation steps
|
||||
2. TODO: Add implementation steps
|
||||
3. TODO: Add implementation steps
|
||||
|
||||
## Acceptance Criteria
|
||||
- [ ] Task 7.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 ./...
|
||||
```
|
||||
|
||||
@@ -0,0 +1,40 @@
|
||||
# Task 7.2.2: Create integration test suite:
|
||||
|
||||
## Metadata
|
||||
- **Task ID**: 7.2.2
|
||||
- **Title**: Create integration test suite:
|
||||
- **Phase**: 7 - Testing, Documentation & CI/CD
|
||||
- **Section**: 7.2
|
||||
- **Status**: Pending
|
||||
- **Priority**: High
|
||||
- **Estimated Time**: TBD
|
||||
- **Dependencies**: TBD
|
||||
|
||||
## Description
|
||||
Create integration test suite:
|
||||
|
||||
## Requirements
|
||||
- Create integration test suite:
|
||||
|
||||
## Implementation Steps
|
||||
1. TODO: Add implementation steps
|
||||
2. TODO: Add implementation steps
|
||||
3. TODO: Add implementation steps
|
||||
|
||||
## Acceptance Criteria
|
||||
- [ ] Task 7.2.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/content/stories/phase7/7.2.3-test-scenarios.md
Normal file
40
docs/content/stories/phase7/7.2.3-test-scenarios.md
Normal file
@@ -0,0 +1,40 @@
|
||||
# Task 7.2.3: Test scenarios:
|
||||
|
||||
## Metadata
|
||||
- **Task ID**: 7.2.3
|
||||
- **Title**: Test scenarios:
|
||||
- **Phase**: 7 - Testing, Documentation & CI/CD
|
||||
- **Section**: 7.2
|
||||
- **Status**: Pending
|
||||
- **Priority**: High
|
||||
- **Estimated Time**: TBD
|
||||
- **Dependencies**: TBD
|
||||
|
||||
## Description
|
||||
Test scenarios:
|
||||
|
||||
## Requirements
|
||||
- Test scenarios:
|
||||
|
||||
## Implementation Steps
|
||||
1. TODO: Add implementation steps
|
||||
2. TODO: Add implementation steps
|
||||
3. TODO: Add implementation steps
|
||||
|
||||
## Acceptance Criteria
|
||||
- [ ] Task 7.2.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 ./...
|
||||
```
|
||||
|
||||
@@ -0,0 +1,40 @@
|
||||
# Task 7.2.4: Create `docker-compose.test.yml`:
|
||||
|
||||
## Metadata
|
||||
- **Task ID**: 7.2.4
|
||||
- **Title**: Create `docker-compose.test.yml`:
|
||||
- **Phase**: 7 - Testing, Documentation & CI/CD
|
||||
- **Section**: 7.2
|
||||
- **Status**: Pending
|
||||
- **Priority**: High
|
||||
- **Estimated Time**: TBD
|
||||
- **Dependencies**: TBD
|
||||
|
||||
## Description
|
||||
Create `docker-compose.test.yml`:
|
||||
|
||||
## Requirements
|
||||
- Create `docker-compose.test.yml`:
|
||||
|
||||
## Implementation Steps
|
||||
1. TODO: Add implementation steps
|
||||
2. TODO: Add implementation steps
|
||||
3. TODO: Add implementation steps
|
||||
|
||||
## Acceptance Criteria
|
||||
- [ ] Task 7.2.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 ./...
|
||||
```
|
||||
|
||||
@@ -0,0 +1,40 @@
|
||||
# Task 7.2.5: Add test tags: `//go:build integration`
|
||||
|
||||
## Metadata
|
||||
- **Task ID**: 7.2.5
|
||||
- **Title**: Add test tags: `//go:build integration`
|
||||
- **Phase**: 7 - Testing, Documentation & CI/CD
|
||||
- **Section**: 7.2
|
||||
- **Status**: Pending
|
||||
- **Priority**: High
|
||||
- **Estimated Time**: TBD
|
||||
- **Dependencies**: TBD
|
||||
|
||||
## Description
|
||||
Add test tags: `//go:build integration`
|
||||
|
||||
## Requirements
|
||||
- Add test tags: `//go:build integration`
|
||||
|
||||
## Implementation Steps
|
||||
1. TODO: Add implementation steps
|
||||
2. TODO: Add implementation steps
|
||||
3. TODO: Add implementation steps
|
||||
|
||||
## Acceptance Criteria
|
||||
- [ ] Task 7.2.5 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 ./...
|
||||
```
|
||||
|
||||
@@ -0,0 +1,40 @@
|
||||
# Task 7.3.1: Install `github.com/pact-foundation/pact-go` (optional)
|
||||
|
||||
## Metadata
|
||||
- **Task ID**: 7.3.1
|
||||
- **Title**: Install `github.com/pact-foundation/pact-go` (optional)
|
||||
- **Phase**: 7 - Testing, Documentation & CI/CD
|
||||
- **Section**: 7.3
|
||||
- **Status**: Pending
|
||||
- **Priority**: High
|
||||
- **Estimated Time**: TBD
|
||||
- **Dependencies**: TBD
|
||||
|
||||
## Description
|
||||
Install `github.com/pact-foundation/pact-go` (optional)
|
||||
|
||||
## Requirements
|
||||
- Install `github.com/pact-foundation/pact-go` (optional)
|
||||
|
||||
## Implementation Steps
|
||||
1. TODO: Add implementation steps
|
||||
2. TODO: Add implementation steps
|
||||
3. TODO: Add implementation steps
|
||||
|
||||
## Acceptance Criteria
|
||||
- [ ] Task 7.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 ./...
|
||||
```
|
||||
|
||||
@@ -0,0 +1,40 @@
|
||||
# Task 7.3.2: Create API contract tests:
|
||||
|
||||
## Metadata
|
||||
- **Task ID**: 7.3.2
|
||||
- **Title**: Create API contract tests:
|
||||
- **Phase**: 7 - Testing, Documentation & CI/CD
|
||||
- **Section**: 7.3
|
||||
- **Status**: Pending
|
||||
- **Priority**: High
|
||||
- **Estimated Time**: TBD
|
||||
- **Dependencies**: TBD
|
||||
|
||||
## Description
|
||||
Create API contract tests:
|
||||
|
||||
## Requirements
|
||||
- Create API contract tests:
|
||||
|
||||
## Implementation Steps
|
||||
1. TODO: Add implementation steps
|
||||
2. TODO: Add implementation steps
|
||||
3. TODO: Add implementation steps
|
||||
|
||||
## Acceptance Criteria
|
||||
- [ ] Task 7.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/content/stories/phase7/7.3.3-use-openapi-validator.md
Normal file
40
docs/content/stories/phase7/7.3.3-use-openapi-validator.md
Normal file
@@ -0,0 +1,40 @@
|
||||
# Task 7.3.3: Use OpenAPI validator:
|
||||
|
||||
## Metadata
|
||||
- **Task ID**: 7.3.3
|
||||
- **Title**: Use OpenAPI validator:
|
||||
- **Phase**: 7 - Testing, Documentation & CI/CD
|
||||
- **Section**: 7.3
|
||||
- **Status**: Pending
|
||||
- **Priority**: High
|
||||
- **Estimated Time**: TBD
|
||||
- **Dependencies**: TBD
|
||||
|
||||
## Description
|
||||
Use OpenAPI validator:
|
||||
|
||||
## Requirements
|
||||
- Use OpenAPI validator:
|
||||
|
||||
## Implementation Steps
|
||||
1. TODO: Add implementation steps
|
||||
2. TODO: Add implementation steps
|
||||
3. TODO: Add implementation steps
|
||||
|
||||
## Acceptance Criteria
|
||||
- [ ] Task 7.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 ./...
|
||||
```
|
||||
|
||||
@@ -0,0 +1,40 @@
|
||||
# Task 7.4.1: Create `perf/` directory with k6 scripts:
|
||||
|
||||
## Metadata
|
||||
- **Task ID**: 7.4.1
|
||||
- **Title**: Create `perf/` directory with k6 scripts:
|
||||
- **Phase**: 7 - Testing, Documentation & CI/CD
|
||||
- **Section**: 7.4
|
||||
- **Status**: Pending
|
||||
- **Priority**: High
|
||||
- **Estimated Time**: TBD
|
||||
- **Dependencies**: TBD
|
||||
|
||||
## Description
|
||||
Create `perf/` directory with k6 scripts:
|
||||
|
||||
## Requirements
|
||||
- Create `perf/` directory with k6 scripts:
|
||||
|
||||
## Implementation Steps
|
||||
1. TODO: Add implementation steps
|
||||
2. TODO: Add implementation steps
|
||||
3. TODO: Add implementation steps
|
||||
|
||||
## Acceptance Criteria
|
||||
- [ ] Task 7.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 ./...
|
||||
```
|
||||
|
||||
@@ -0,0 +1,40 @@
|
||||
# Task 7.4.2: Document performance benchmarks:
|
||||
|
||||
## Metadata
|
||||
- **Task ID**: 7.4.2
|
||||
- **Title**: Document performance benchmarks:
|
||||
- **Phase**: 7 - Testing, Documentation & CI/CD
|
||||
- **Section**: 7.4
|
||||
- **Status**: Pending
|
||||
- **Priority**: High
|
||||
- **Estimated Time**: TBD
|
||||
- **Dependencies**: TBD
|
||||
|
||||
## Description
|
||||
Document performance benchmarks:
|
||||
|
||||
## Requirements
|
||||
- Document performance benchmarks:
|
||||
|
||||
## Implementation Steps
|
||||
1. TODO: Add implementation steps
|
||||
2. TODO: Add implementation steps
|
||||
3. TODO: Add implementation steps
|
||||
|
||||
## Acceptance Criteria
|
||||
- [ ] Task 7.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/content/stories/phase7/7.5.1-create-readmemd.md
Normal file
40
docs/content/stories/phase7/7.5.1-create-readmemd.md
Normal file
@@ -0,0 +1,40 @@
|
||||
# Task 7.5.1: Create `README.md`:
|
||||
|
||||
## Metadata
|
||||
- **Task ID**: 7.5.1
|
||||
- **Title**: Create `README.md`:
|
||||
- **Phase**: 7 - Testing, Documentation & CI/CD
|
||||
- **Section**: 7.5
|
||||
- **Status**: Pending
|
||||
- **Priority**: High
|
||||
- **Estimated Time**: TBD
|
||||
- **Dependencies**: TBD
|
||||
|
||||
## Description
|
||||
Create `README.md`:
|
||||
|
||||
## Requirements
|
||||
- Create `README.md`:
|
||||
|
||||
## Implementation Steps
|
||||
1. TODO: Add implementation steps
|
||||
2. TODO: Add implementation steps
|
||||
3. TODO: Add implementation steps
|
||||
|
||||
## Acceptance Criteria
|
||||
- [ ] Task 7.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 ./...
|
||||
```
|
||||
|
||||
@@ -0,0 +1,40 @@
|
||||
# Task 7.5.2: Create `docs/architecture.md`:
|
||||
|
||||
## Metadata
|
||||
- **Task ID**: 7.5.2
|
||||
- **Title**: Create `docs/architecture.md`:
|
||||
- **Phase**: 7 - Testing, Documentation & CI/CD
|
||||
- **Section**: 7.5
|
||||
- **Status**: Pending
|
||||
- **Priority**: High
|
||||
- **Estimated Time**: TBD
|
||||
- **Dependencies**: TBD
|
||||
|
||||
## Description
|
||||
Create `docs/architecture.md`:
|
||||
|
||||
## Requirements
|
||||
- Create `docs/architecture.md`:
|
||||
|
||||
## Implementation Steps
|
||||
1. TODO: Add implementation steps
|
||||
2. TODO: Add implementation steps
|
||||
3. TODO: Add implementation steps
|
||||
|
||||
## Acceptance Criteria
|
||||
- [ ] Task 7.5.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 ./...
|
||||
```
|
||||
|
||||
@@ -0,0 +1,40 @@
|
||||
# Task 7.5.3: Create `docs/extension-points.md`:
|
||||
|
||||
## Metadata
|
||||
- **Task ID**: 7.5.3
|
||||
- **Title**: Create `docs/extension-points.md`:
|
||||
- **Phase**: 7 - Testing, Documentation & CI/CD
|
||||
- **Section**: 7.5
|
||||
- **Status**: Pending
|
||||
- **Priority**: High
|
||||
- **Estimated Time**: TBD
|
||||
- **Dependencies**: TBD
|
||||
|
||||
## Description
|
||||
Create `docs/extension-points.md`:
|
||||
|
||||
## Requirements
|
||||
- Create `docs/extension-points.md`:
|
||||
|
||||
## Implementation Steps
|
||||
1. TODO: Add implementation steps
|
||||
2. TODO: Add implementation steps
|
||||
3. TODO: Add implementation steps
|
||||
|
||||
## Acceptance Criteria
|
||||
- [ ] Task 7.5.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/content/stories/phase7/7.5.4-create-docsapimd.md
Normal file
40
docs/content/stories/phase7/7.5.4-create-docsapimd.md
Normal file
@@ -0,0 +1,40 @@
|
||||
# Task 7.5.4: Create `docs/api.md`:
|
||||
|
||||
## Metadata
|
||||
- **Task ID**: 7.5.4
|
||||
- **Title**: Create `docs/api.md`:
|
||||
- **Phase**: 7 - Testing, Documentation & CI/CD
|
||||
- **Section**: 7.5
|
||||
- **Status**: Pending
|
||||
- **Priority**: High
|
||||
- **Estimated Time**: TBD
|
||||
- **Dependencies**: TBD
|
||||
|
||||
## Description
|
||||
Create `docs/api.md`:
|
||||
|
||||
## Requirements
|
||||
- Create `docs/api.md`:
|
||||
|
||||
## Implementation Steps
|
||||
1. TODO: Add implementation steps
|
||||
2. TODO: Add implementation steps
|
||||
3. TODO: Add implementation steps
|
||||
|
||||
## Acceptance Criteria
|
||||
- [ ] Task 7.5.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/content/stories/phase7/7.5.5-create-docsoperationsmd.md
Normal file
40
docs/content/stories/phase7/7.5.5-create-docsoperationsmd.md
Normal file
@@ -0,0 +1,40 @@
|
||||
# Task 7.5.5: Create `docs/operations.md`:
|
||||
|
||||
## Metadata
|
||||
- **Task ID**: 7.5.5
|
||||
- **Title**: Create `docs/operations.md`:
|
||||
- **Phase**: 7 - Testing, Documentation & CI/CD
|
||||
- **Section**: 7.5
|
||||
- **Status**: Pending
|
||||
- **Priority**: High
|
||||
- **Estimated Time**: TBD
|
||||
- **Dependencies**: TBD
|
||||
|
||||
## Description
|
||||
Create `docs/operations.md`:
|
||||
|
||||
## Requirements
|
||||
- Create `docs/operations.md`:
|
||||
|
||||
## Implementation Steps
|
||||
1. TODO: Add implementation steps
|
||||
2. TODO: Add implementation steps
|
||||
3. TODO: Add implementation steps
|
||||
|
||||
## Acceptance Criteria
|
||||
- [ ] Task 7.5.5 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/content/stories/phase7/7.5.6-add-code-examples.md
Normal file
40
docs/content/stories/phase7/7.5.6-add-code-examples.md
Normal file
@@ -0,0 +1,40 @@
|
||||
# Task 7.5.6: Add code examples:
|
||||
|
||||
## Metadata
|
||||
- **Task ID**: 7.5.6
|
||||
- **Title**: Add code examples:
|
||||
- **Phase**: 7 - Testing, Documentation & CI/CD
|
||||
- **Section**: 7.5
|
||||
- **Status**: Pending
|
||||
- **Priority**: High
|
||||
- **Estimated Time**: TBD
|
||||
- **Dependencies**: TBD
|
||||
|
||||
## Description
|
||||
Add code examples:
|
||||
|
||||
## Requirements
|
||||
- Add code examples:
|
||||
|
||||
## Implementation Steps
|
||||
1. TODO: Add implementation steps
|
||||
2. TODO: Add implementation steps
|
||||
3. TODO: Add implementation steps
|
||||
|
||||
## Acceptance Criteria
|
||||
- [ ] Task 7.5.6 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 ./...
|
||||
```
|
||||
|
||||
@@ -0,0 +1,40 @@
|
||||
# Task 7.6.1: Update `.github/workflows/ci.yml`:
|
||||
|
||||
## Metadata
|
||||
- **Task ID**: 7.6.1
|
||||
- **Title**: Update `.github/workflows/ci.yml`:
|
||||
- **Phase**: 7 - Testing, Documentation & CI/CD
|
||||
- **Section**: 7.6
|
||||
- **Status**: Pending
|
||||
- **Priority**: High
|
||||
- **Estimated Time**: TBD
|
||||
- **Dependencies**: TBD
|
||||
|
||||
## Description
|
||||
Update `.github/workflows/ci.yml`:
|
||||
|
||||
## Requirements
|
||||
- Update `.github/workflows/ci.yml`:
|
||||
|
||||
## Implementation Steps
|
||||
1. TODO: Add implementation steps
|
||||
2. TODO: Add implementation steps
|
||||
3. TODO: Add implementation steps
|
||||
|
||||
## Acceptance Criteria
|
||||
- [ ] Task 7.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 ./...
|
||||
```
|
||||
|
||||
40
docs/content/stories/phase7/7.6.2-add-release-workflow.md
Normal file
40
docs/content/stories/phase7/7.6.2-add-release-workflow.md
Normal file
@@ -0,0 +1,40 @@
|
||||
# Task 7.6.2: Add release workflow:
|
||||
|
||||
## Metadata
|
||||
- **Task ID**: 7.6.2
|
||||
- **Title**: Add release workflow:
|
||||
- **Phase**: 7 - Testing, Documentation & CI/CD
|
||||
- **Section**: 7.6
|
||||
- **Status**: Pending
|
||||
- **Priority**: High
|
||||
- **Estimated Time**: TBD
|
||||
- **Dependencies**: TBD
|
||||
|
||||
## Description
|
||||
Add release workflow:
|
||||
|
||||
## Requirements
|
||||
- Add release workflow:
|
||||
|
||||
## Implementation Steps
|
||||
1. TODO: Add implementation steps
|
||||
2. TODO: Add implementation steps
|
||||
3. TODO: Add implementation steps
|
||||
|
||||
## Acceptance Criteria
|
||||
- [ ] Task 7.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 ./...
|
||||
```
|
||||
|
||||
40
docs/content/stories/phase7/7.6.3-add-security-scanning.md
Normal file
40
docs/content/stories/phase7/7.6.3-add-security-scanning.md
Normal file
@@ -0,0 +1,40 @@
|
||||
# Task 7.6.3: Add security scanning:
|
||||
|
||||
## Metadata
|
||||
- **Task ID**: 7.6.3
|
||||
- **Title**: Add security scanning:
|
||||
- **Phase**: 7 - Testing, Documentation & CI/CD
|
||||
- **Section**: 7.6
|
||||
- **Status**: Pending
|
||||
- **Priority**: High
|
||||
- **Estimated Time**: TBD
|
||||
- **Dependencies**: TBD
|
||||
|
||||
## Description
|
||||
Add security scanning:
|
||||
|
||||
## Requirements
|
||||
- Add security scanning:
|
||||
|
||||
## Implementation Steps
|
||||
1. TODO: Add implementation steps
|
||||
2. TODO: Add implementation steps
|
||||
3. TODO: Add implementation steps
|
||||
|
||||
## Acceptance Criteria
|
||||
- [ ] Task 7.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 ./...
|
||||
```
|
||||
|
||||
@@ -0,0 +1,52 @@
|
||||
# Task 7.7.1: Create multi-stage `Dockerfile`:
|
||||
|
||||
## Metadata
|
||||
- **Task ID**: 7.7.1
|
||||
- **Title**: Create multi-stage `Dockerfile`:
|
||||
- **Phase**: 7 - Testing, Documentation & CI/CD
|
||||
- **Section**: 7.7
|
||||
- **Status**: Pending
|
||||
- **Priority**: High
|
||||
- **Estimated Time**: TBD
|
||||
- **Dependencies**: TBD
|
||||
|
||||
## Description
|
||||
Create multi-stage `Dockerfile`:
|
||||
|
||||
## Requirements
|
||||
- Create multi-stage `Dockerfile`:
|
||||
|
||||
## Implementation Steps
|
||||
1. TODO: Add implementation steps
|
||||
2. TODO: Add implementation steps
|
||||
3. TODO: Add implementation steps
|
||||
|
||||
## Acceptance Criteria
|
||||
- [ ] Task 7.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
|
||||
# Build stage
|
||||
FROM golang:1.22-alpine AS builder
|
||||
# ... build commands
|
||||
|
||||
# Runtime stage
|
||||
FROM gcr.io/distroless/static-debian12
|
||||
# ... copy binary
|
||||
```
|
||||
@@ -0,0 +1,40 @@
|
||||
# Task 7.7.2: Create `docker-compose.yml` for development:
|
||||
|
||||
## Metadata
|
||||
- **Task ID**: 7.7.2
|
||||
- **Title**: Create `docker-compose.yml` for development:
|
||||
- **Phase**: 7 - Testing, Documentation & CI/CD
|
||||
- **Section**: 7.7
|
||||
- **Status**: Pending
|
||||
- **Priority**: High
|
||||
- **Estimated Time**: TBD
|
||||
- **Dependencies**: TBD
|
||||
|
||||
## Description
|
||||
Create `docker-compose.yml` for development:
|
||||
|
||||
## Requirements
|
||||
- Create `docker-compose.yml` for development:
|
||||
|
||||
## Implementation Steps
|
||||
1. TODO: Add implementation steps
|
||||
2. TODO: Add implementation steps
|
||||
3. TODO: Add implementation steps
|
||||
|
||||
## Acceptance Criteria
|
||||
- [ ] Task 7.7.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 ./...
|
||||
```
|
||||
|
||||
@@ -0,0 +1,40 @@
|
||||
# Task 7.7.3: Create `docker-compose.prod.yml` for production
|
||||
|
||||
## Metadata
|
||||
- **Task ID**: 7.7.3
|
||||
- **Title**: Create `docker-compose.prod.yml` for production
|
||||
- **Phase**: 7 - Testing, Documentation & CI/CD
|
||||
- **Section**: 7.7
|
||||
- **Status**: Pending
|
||||
- **Priority**: High
|
||||
- **Estimated Time**: TBD
|
||||
- **Dependencies**: TBD
|
||||
|
||||
## Description
|
||||
Create `docker-compose.prod.yml` for production
|
||||
|
||||
## Requirements
|
||||
- Create `docker-compose.prod.yml` for production
|
||||
|
||||
## Implementation Steps
|
||||
1. TODO: Add implementation steps
|
||||
2. TODO: Add implementation steps
|
||||
3. TODO: Add implementation steps
|
||||
|
||||
## Acceptance Criteria
|
||||
- [ ] Task 7.7.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 ./...
|
||||
```
|
||||
|
||||
@@ -0,0 +1,40 @@
|
||||
# Task 7.7.4: Add health checks to Dockerfile
|
||||
|
||||
## Metadata
|
||||
- **Task ID**: 7.7.4
|
||||
- **Title**: Add health checks to Dockerfile
|
||||
- **Phase**: 7 - Testing, Documentation & CI/CD
|
||||
- **Section**: 7.7
|
||||
- **Status**: Pending
|
||||
- **Priority**: High
|
||||
- **Estimated Time**: TBD
|
||||
- **Dependencies**: TBD
|
||||
|
||||
## Description
|
||||
Add health checks to Dockerfile
|
||||
|
||||
## Requirements
|
||||
- Add health checks to Dockerfile
|
||||
|
||||
## Implementation Steps
|
||||
1. TODO: Add implementation steps
|
||||
2. TODO: Add implementation steps
|
||||
3. TODO: Add implementation steps
|
||||
|
||||
## Acceptance Criteria
|
||||
- [ ] Task 7.7.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 ./...
|
||||
```
|
||||
|
||||
@@ -0,0 +1,40 @@
|
||||
# Task 7.7.5: Document Docker usage in `docs/deployment.md`
|
||||
|
||||
## Metadata
|
||||
- **Task ID**: 7.7.5
|
||||
- **Title**: Document Docker usage in `docs/deployment.md`
|
||||
- **Phase**: 7 - Testing, Documentation & CI/CD
|
||||
- **Section**: 7.7
|
||||
- **Status**: Pending
|
||||
- **Priority**: High
|
||||
- **Estimated Time**: TBD
|
||||
- **Dependencies**: TBD
|
||||
|
||||
## Description
|
||||
Document Docker usage in `docs/deployment.md`
|
||||
|
||||
## Requirements
|
||||
- Document Docker usage in `docs/deployment.md`
|
||||
|
||||
## Implementation Steps
|
||||
1. TODO: Add implementation steps
|
||||
2. TODO: Add implementation steps
|
||||
3. TODO: Add implementation steps
|
||||
|
||||
## Acceptance Criteria
|
||||
- [ ] Task 7.7.5 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 ./...
|
||||
```
|
||||
|
||||
@@ -0,0 +1,40 @@
|
||||
# Task 7.8.1: Create `docs/deployment/kubernetes.md`:
|
||||
|
||||
## Metadata
|
||||
- **Task ID**: 7.8.1
|
||||
- **Title**: Create `docs/deployment/kubernetes.md`:
|
||||
- **Phase**: 7 - Testing, Documentation & CI/CD
|
||||
- **Section**: 7.8
|
||||
- **Status**: Pending
|
||||
- **Priority**: High
|
||||
- **Estimated Time**: TBD
|
||||
- **Dependencies**: TBD
|
||||
|
||||
## Description
|
||||
Create `docs/deployment/kubernetes.md`:
|
||||
|
||||
## Requirements
|
||||
- Create `docs/deployment/kubernetes.md`:
|
||||
|
||||
## Implementation Steps
|
||||
1. TODO: Add implementation steps
|
||||
2. TODO: Add implementation steps
|
||||
3. TODO: Add implementation steps
|
||||
|
||||
## Acceptance Criteria
|
||||
- [ ] Task 7.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 ./...
|
||||
```
|
||||
|
||||
@@ -0,0 +1,40 @@
|
||||
# Task 7.8.2: Create `docs/deployment/docker.md`:
|
||||
|
||||
## Metadata
|
||||
- **Task ID**: 7.8.2
|
||||
- **Title**: Create `docs/deployment/docker.md`:
|
||||
- **Phase**: 7 - Testing, Documentation & CI/CD
|
||||
- **Section**: 7.8
|
||||
- **Status**: Pending
|
||||
- **Priority**: High
|
||||
- **Estimated Time**: TBD
|
||||
- **Dependencies**: TBD
|
||||
|
||||
## Description
|
||||
Create `docs/deployment/docker.md`:
|
||||
|
||||
## Requirements
|
||||
- Create `docs/deployment/docker.md`:
|
||||
|
||||
## Implementation Steps
|
||||
1. TODO: Add implementation steps
|
||||
2. TODO: Add implementation steps
|
||||
3. TODO: Add implementation steps
|
||||
|
||||
## Acceptance Criteria
|
||||
- [ ] Task 7.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 ./...
|
||||
```
|
||||
|
||||
@@ -0,0 +1,40 @@
|
||||
# Task 7.8.3: Create `docs/deployment/cloud.md`:
|
||||
|
||||
## Metadata
|
||||
- **Task ID**: 7.8.3
|
||||
- **Title**: Create `docs/deployment/cloud.md`:
|
||||
- **Phase**: 7 - Testing, Documentation & CI/CD
|
||||
- **Section**: 7.8
|
||||
- **Status**: Pending
|
||||
- **Priority**: High
|
||||
- **Estimated Time**: TBD
|
||||
- **Dependencies**: TBD
|
||||
|
||||
## Description
|
||||
Create `docs/deployment/cloud.md`:
|
||||
|
||||
## Requirements
|
||||
- Create `docs/deployment/cloud.md`:
|
||||
|
||||
## Implementation Steps
|
||||
1. TODO: Add implementation steps
|
||||
2. TODO: Add implementation steps
|
||||
3. TODO: Add implementation steps
|
||||
|
||||
## Acceptance Criteria
|
||||
- [ ] Task 7.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 ./...
|
||||
```
|
||||
|
||||
@@ -0,0 +1,51 @@
|
||||
# Task 7.9.1: Create `Makefile` with common tasks:
|
||||
|
||||
## Metadata
|
||||
- **Task ID**: 7.9.1
|
||||
- **Title**: Create `Makefile` with common tasks:
|
||||
- **Phase**: 7 - Testing, Documentation & CI/CD
|
||||
- **Section**: 7.9
|
||||
- **Status**: Pending
|
||||
- **Priority**: High
|
||||
- **Estimated Time**: TBD
|
||||
- **Dependencies**: TBD
|
||||
|
||||
## Description
|
||||
Create `Makefile` with common tasks:
|
||||
|
||||
## Requirements
|
||||
- Create `Makefile` with common tasks:
|
||||
|
||||
## Implementation Steps
|
||||
1. TODO: Add implementation steps
|
||||
2. TODO: Add implementation steps
|
||||
3. TODO: Add implementation steps
|
||||
|
||||
## Acceptance Criteria
|
||||
- [ ] Task 7.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 ./...
|
||||
```
|
||||
|
||||
|
||||
## Code Reference
|
||||
|
||||
```go
|
||||
make dev # Start dev environment
|
||||
make test # Run tests
|
||||
make lint # Run linters
|
||||
make generate # Generate code
|
||||
make docker-build # Build Docker image
|
||||
make migrate # Run migrations
|
||||
```
|
||||
40
docs/content/stories/phase7/7.9.2-add-development-scripts.md
Normal file
40
docs/content/stories/phase7/7.9.2-add-development-scripts.md
Normal file
@@ -0,0 +1,40 @@
|
||||
# Task 7.9.2: Add development scripts:
|
||||
|
||||
## Metadata
|
||||
- **Task ID**: 7.9.2
|
||||
- **Title**: Add development scripts:
|
||||
- **Phase**: 7 - Testing, Documentation & CI/CD
|
||||
- **Section**: 7.9
|
||||
- **Status**: Pending
|
||||
- **Priority**: High
|
||||
- **Estimated Time**: TBD
|
||||
- **Dependencies**: TBD
|
||||
|
||||
## Description
|
||||
Add development scripts:
|
||||
|
||||
## Requirements
|
||||
- Add development scripts:
|
||||
|
||||
## Implementation Steps
|
||||
1. TODO: Add implementation steps
|
||||
2. TODO: Add implementation steps
|
||||
3. TODO: Add implementation steps
|
||||
|
||||
## Acceptance Criteria
|
||||
- [ ] Task 7.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 ./...
|
||||
```
|
||||
|
||||
@@ -0,0 +1,40 @@
|
||||
# Task 7.9.3: Create `.env.example` with all config variables
|
||||
|
||||
## Metadata
|
||||
- **Task ID**: 7.9.3
|
||||
- **Title**: Create `.env.example` with all config variables
|
||||
- **Phase**: 7 - Testing, Documentation & CI/CD
|
||||
- **Section**: 7.9
|
||||
- **Status**: Pending
|
||||
- **Priority**: High
|
||||
- **Estimated Time**: TBD
|
||||
- **Dependencies**: TBD
|
||||
|
||||
## Description
|
||||
Create `.env.example` with all config variables
|
||||
|
||||
## Requirements
|
||||
- Create `.env.example` with all config variables
|
||||
|
||||
## Implementation Steps
|
||||
1. TODO: Add implementation steps
|
||||
2. TODO: Add implementation steps
|
||||
3. TODO: Add implementation steps
|
||||
|
||||
## Acceptance Criteria
|
||||
- [ ] Task 7.9.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 ./...
|
||||
```
|
||||
|
||||
@@ -0,0 +1,40 @@
|
||||
# Task 7.9.4: Add pre-commit hooks (optional):
|
||||
|
||||
## Metadata
|
||||
- **Task ID**: 7.9.4
|
||||
- **Title**: Add pre-commit hooks (optional):
|
||||
- **Phase**: 7 - Testing, Documentation & CI/CD
|
||||
- **Section**: 7.9
|
||||
- **Status**: Pending
|
||||
- **Priority**: High
|
||||
- **Estimated Time**: TBD
|
||||
- **Dependencies**: TBD
|
||||
|
||||
## Description
|
||||
Add pre-commit hooks (optional):
|
||||
|
||||
## Requirements
|
||||
- Add pre-commit hooks (optional):
|
||||
|
||||
## Implementation Steps
|
||||
1. TODO: Add implementation steps
|
||||
2. TODO: Add implementation steps
|
||||
3. TODO: Add implementation steps
|
||||
|
||||
## Acceptance Criteria
|
||||
- [ ] Task 7.9.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 ./...
|
||||
```
|
||||
|
||||
56
docs/content/stories/phase7/README.md
Normal file
56
docs/content/stories/phase7/README.md
Normal file
@@ -0,0 +1,56 @@
|
||||
# Phase 7: Testing, Documentation & CI/CD
|
||||
|
||||
## Overview
|
||||
Establish comprehensive testing strategy with unit, integration, and contract tests. Complete CI/CD pipeline, generate API documentation, and create deployment guides.
|
||||
|
||||
## Tasks
|
||||
|
||||
### 7.1 Unit Testing
|
||||
- [7.1.1 - Achieve 80% Code Coverage](./7.1.1-achieve-80-code-coverage-for-core-modules.md)
|
||||
- [7.1.2 - Use Testify for Assertions](./7.1.2-use-githubcomstretchrtestify-for-assertions.md)
|
||||
- [7.1.3 - Use Mockery for Mocks](./7.1.3-use-githubcomgolangmock-or-mockery-for-mocks.md)
|
||||
- [7.1.4 - Add Test Helpers](./7.1.4-add-test-helpers.md)
|
||||
|
||||
### 7.2 Integration Testing
|
||||
- [7.2.1 - Install Testcontainers](./7.2.1-install-githubcomtestcontainerstestcontainers-go.md)
|
||||
- [7.2.2 - Create Integration Test Suite](./7.2.2-create-integration-test-suite.md)
|
||||
- [7.2.3 - Test Scenarios](./7.2.3-test-scenarios.md)
|
||||
- [7.2.4 - Create Docker Compose Test](./7.2.4-create-docker-composetestyml.md)
|
||||
- [7.2.5 - Add Test Tags](./7.2.5-add-test-tags-gobuild-integration.md)
|
||||
|
||||
### 7.3 Contract Testing
|
||||
- [7.3.1 - Install Pact Go](./7.3.1-install-githubcompact-foundationpact-go-optional.md)
|
||||
- [7.3.2 - Create Contract Tests](./7.3.2-create-contract-tests.md)
|
||||
|
||||
### 7.4 API Documentation
|
||||
- [7.4.1 - Generate OpenAPI Spec](./7.4.1-generate-openapi-spec.md)
|
||||
- [7.4.2 - Add Swagger UI](./7.4.2-add-swagger-ui.md)
|
||||
- [7.4.3 - Document API Endpoints](./7.4.3-document-api-endpoints.md)
|
||||
|
||||
### 7.5 CI/CD Pipeline
|
||||
- [7.5.1 - Enhance GitHub Actions](./7.5.1-enhance-github-actions-workflow.md)
|
||||
- [7.5.2 - Add Test Coverage Reporting](./7.5.2-add-test-coverage-reporting.md)
|
||||
- [7.5.3 - Add Docker Image Building](./7.5.3-add-docker-image-building.md)
|
||||
- [7.5.4 - Add Deployment Workflows](./7.5.4-add-deployment-workflows.md)
|
||||
|
||||
### 7.6 Documentation
|
||||
- [7.6.1 - Create Developer Guide](./7.6.1-create-developer-guide.md)
|
||||
- [7.6.2 - Create Deployment Guide](./7.6.2-create-deployment-guide.md)
|
||||
- [7.6.3 - Create Module Development Guide](./7.6.3-create-module-development-guide.md)
|
||||
|
||||
## Deliverables Checklist
|
||||
- [ ] Unit tests achieve 80% coverage
|
||||
- [ ] Integration tests with testcontainers
|
||||
- [ ] Contract tests for API
|
||||
- [ ] OpenAPI documentation generated
|
||||
- [ ] CI/CD pipeline complete
|
||||
- [ ] Comprehensive documentation
|
||||
|
||||
## Acceptance Criteria
|
||||
- `make test` runs all tests
|
||||
- `make test-integration` runs integration tests
|
||||
- CI pipeline passes on all PRs
|
||||
- API documentation is up-to-date
|
||||
- Deployment guides are complete
|
||||
- Code coverage reports are generated
|
||||
|
||||
Reference in New Issue
Block a user