@sallmarta/eye-hate-agent 1.0.3 → 1.0.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +52 -28
- package/docs/templates/project-docs-template/index.md +192 -50
- package/docs/templates/project-docs-template/technical-guidelines/index.md +50 -21
- package/docs/templates/reusable-prompts/00-project-docs-bootstrap.md +26 -43
- package/docs/templates/reusable-prompts/00-project-docs-parity.md +1 -1
- package/docs/templates/reusable-prompts/00-project-docs-refresh.md +9 -7
- package/docs/templates/reusable-prompts/01-sdd-execute.md +1 -1
- package/docs/templates/reusable-prompts/02-sdd-discuss.md +1 -1
- package/docs/templates/rules/agent-rules.md +1 -1
- package/docs/templates/skills/{architecture/api-design → api-design}/SKILL.md +14 -25
- package/docs/templates/skills/{auditing/full-verification → code-audit}/SKILL.md +35 -53
- package/docs/templates/skills/db-schema-design/SKILL.md +120 -0
- package/docs/templates/skills/devops-ci-cd/SKILL.md +99 -0
- package/docs/templates/skills/observability/SKILL.md +99 -0
- package/docs/templates/skills/{auditing/parity → parity-audit}/SKILL.md +24 -50
- package/docs/templates/skills/refactor/SKILL.md +100 -0
- package/docs/templates/skills/security-audit/SKILL.md +149 -0
- package/docs/templates/skills/{architecture/system-analysis → system-analysis}/SKILL.md +19 -41
- package/docs/templates/skills/{engineering/test-authoring → system-tester}/SKILL.md +28 -222
- package/docs/templates/skills/ui-ux-design/SKILL.md +102 -0
- package/docs/templates/skills/wireframing/SKILL.md +88 -0
- package/package.json +1 -1
- package/src/engine/index.js +2 -0
- package/src/engine/install.js +1 -3
- package/src/engine/runtime-adapters.js +7 -4
- package/src/engine/skill-registry.js +37 -32
- package/docs/templates/project-docs-template/foundation/architecture.md +0 -79
- package/docs/templates/project-docs-template/foundation/changelog.md +0 -53
- package/docs/templates/project-docs-template/foundation/feature-inventory.md +0 -46
- package/docs/templates/project-docs-template/foundation/phases.md +0 -60
- package/docs/templates/project-docs-template/foundation/prd.md +0 -69
- package/docs/templates/project-docs-template/foundation/status.md +0 -57
- package/docs/templates/project-docs-template/foundation/workflow.md +0 -59
- package/docs/templates/project-docs-template/getting-started.md +0 -52
- package/docs/templates/project-docs-template/operations/ci-cd.md +0 -56
- package/docs/templates/project-docs-template/operations/compliance.md +0 -46
- package/docs/templates/project-docs-template/operations/governance.md +0 -46
- package/docs/templates/project-docs-template/operations/observability.md +0 -53
- package/docs/templates/project-docs-template/operations/production-runbook.md +0 -62
- package/docs/templates/project-docs-template/operations/security.md +0 -49
- package/docs/templates/project-docs-template/technical/api-contract.md +0 -49
- package/docs/templates/project-docs-template/technical/database.md +0 -59
- package/docs/templates/project-docs-template/technical/error-handling.md +0 -54
- package/docs/templates/project-docs-template/technical/internationalization.md +0 -46
- package/docs/templates/project-docs-template/technical/testing.md +0 -57
- package/docs/templates/project-docs-template/technical/ui-ux.md +0 -68
- package/docs/templates/skills/architecture/db-schema-design/SKILL.md +0 -14
- package/docs/templates/skills/auditing/security-audit/SKILL.md +0 -170
- package/docs/templates/skills/engineering/refactor-specialist/SKILL.md +0 -13
- package/docs/templates/skills/engineering/ui-ux-implementation/SKILL.md +0 -13
- package/docs/templates/skills/operations/ci-cd-authoring/SKILL.md +0 -13
- package/docs/templates/skills/operations/observability-setup/SKILL.md +0 -13
|
@@ -1,46 +0,0 @@
|
|
|
1
|
-
# Governance
|
|
2
|
-
|
|
3
|
-
Last update: YYYY-MM-DD
|
|
4
|
-
|
|
5
|
-
Status: [Proposed | Draft | Live | Deprecated | Archived]
|
|
6
|
-
|
|
7
|
-
---
|
|
8
|
-
|
|
9
|
-
## 1. Description
|
|
10
|
-
Briefly describe the purpose of this document and what it contains.
|
|
11
|
-
|
|
12
|
-
## 2. Important
|
|
13
|
-
Notes of important findings or critical constraints. Can be empty.
|
|
14
|
-
|
|
15
|
-
## 3. Table of Contents
|
|
16
|
-
[Generate a hyperlinked table of contents here containing ALL headings in this file (1 through N). Use standard markdown links, e.g., - [1. Description](#1-description)]
|
|
17
|
-
|
|
18
|
-
## 4. Scope
|
|
19
|
-
The boundaries of what this document covers.
|
|
20
|
-
|
|
21
|
-
## 5. Goals
|
|
22
|
-
What we aim to achieve with this specific document.
|
|
23
|
-
|
|
24
|
-
## 6. Non Goals
|
|
25
|
-
What is explicitly excluded from the scope of this document.
|
|
26
|
-
|
|
27
|
-
## 7. Versioning Policy (SemVer)
|
|
28
|
-
Rules for major, minor, and patch bumps.
|
|
29
|
-
|
|
30
|
-
## 8. Release Cadence
|
|
31
|
-
Scheduled deploy windows (e.g., every Tuesday).
|
|
32
|
-
|
|
33
|
-
## 9. Code Ownership & Maintainers
|
|
34
|
-
Who is responsible for which modules.
|
|
35
|
-
|
|
36
|
-
## 10. Contribution Guidelines
|
|
37
|
-
Rules for external or cross-team PRs.
|
|
38
|
-
|
|
39
|
-
## 11. Success Metrics
|
|
40
|
-
How we measure if the goals of this document are achieved.
|
|
41
|
-
|
|
42
|
-
## 12. Related Documents
|
|
43
|
-
[Link to related document](path) - Short brief note about why it's related.
|
|
44
|
-
|
|
45
|
-
## 13. Open Questions
|
|
46
|
-
Any unresolved questions or assumptions. Can be empty.
|
|
@@ -1,53 +0,0 @@
|
|
|
1
|
-
# Observability & Telemetry
|
|
2
|
-
|
|
3
|
-
Last update: YYYY-MM-DD
|
|
4
|
-
|
|
5
|
-
Status: [Proposed | Draft | Live | Deprecated | Archived]
|
|
6
|
-
|
|
7
|
-
---
|
|
8
|
-
|
|
9
|
-
## 1. Description
|
|
10
|
-
Briefly describe the purpose of this document and what it contains.
|
|
11
|
-
|
|
12
|
-
## 2. Important
|
|
13
|
-
Notes of important findings or critical constraints. Can be empty.
|
|
14
|
-
|
|
15
|
-
## 3. Table of Contents
|
|
16
|
-
[Generate a hyperlinked table of contents here containing ALL headings in this file (1 through N). Use standard markdown links, e.g., - [1. Description](#1-description)]
|
|
17
|
-
|
|
18
|
-
## 4. Scope
|
|
19
|
-
The boundaries of what this document covers.
|
|
20
|
-
|
|
21
|
-
## 5. Goals
|
|
22
|
-
What we aim to achieve with this specific document.
|
|
23
|
-
|
|
24
|
-
## 6. Non Goals
|
|
25
|
-
What is explicitly excluded from the scope of this document.
|
|
26
|
-
|
|
27
|
-
## 7. Logging Strategy & Levels
|
|
28
|
-
Formatting (e.g., JSON) and severity rules (Info/Warn/Error).
|
|
29
|
-
|
|
30
|
-
## 8. Metrics & Dashboards
|
|
31
|
-
Key Performance Indicators (latency, error rates).
|
|
32
|
-
|
|
33
|
-
## 9. Distributed Tracing
|
|
34
|
-
Request IDs and flow mapping across microservices.
|
|
35
|
-
|
|
36
|
-
## 10. Alerting Rules & Thresholds
|
|
37
|
-
Conditions that trigger on-call pages. Flowcharts are preferred. Use mermaid.
|
|
38
|
-
|
|
39
|
-
```mermaid
|
|
40
|
-
graph TD
|
|
41
|
-
A[Alert Triggered] --> B{Severity Level}
|
|
42
|
-
B -- High --> C[Page On-Call]
|
|
43
|
-
B -- Low --> D[Log to Ticket]
|
|
44
|
-
```
|
|
45
|
-
|
|
46
|
-
## 11. Success Metrics
|
|
47
|
-
How we measure if the goals of this document are achieved.
|
|
48
|
-
|
|
49
|
-
## 12. Related Documents
|
|
50
|
-
[Link to related document](path) - Short brief note about why it's related.
|
|
51
|
-
|
|
52
|
-
## 13. Open Questions
|
|
53
|
-
Any unresolved questions or assumptions. Can be empty.
|
|
@@ -1,62 +0,0 @@
|
|
|
1
|
-
# Production Runbook
|
|
2
|
-
|
|
3
|
-
Last update: YYYY-MM-DD
|
|
4
|
-
|
|
5
|
-
Status: [Proposed | Draft | Live | Deprecated | Archived]
|
|
6
|
-
|
|
7
|
-
---
|
|
8
|
-
|
|
9
|
-
## 1. Description
|
|
10
|
-
Describe what this runbook covers and which environment or service it applies to.
|
|
11
|
-
|
|
12
|
-
## 2. Important
|
|
13
|
-
Notes of important findings or critical constraints. Can be empty.
|
|
14
|
-
|
|
15
|
-
## 3. Table of Contents
|
|
16
|
-
[Generate a hyperlinked table of contents here containing ALL headings in this file (1 through N). Use standard markdown links, e.g., - [1. Description](#1-description)]
|
|
17
|
-
|
|
18
|
-
## 4. Scope
|
|
19
|
-
The boundaries of what this document covers.
|
|
20
|
-
|
|
21
|
-
## 5. Goals
|
|
22
|
-
What we aim to achieve with this specific document.
|
|
23
|
-
|
|
24
|
-
## 6. Non Goals
|
|
25
|
-
What is explicitly excluded from the scope of this document.
|
|
26
|
-
|
|
27
|
-
## 7. Environment Overview
|
|
28
|
-
Production environment summary. Key dependencies or infrastructure notes.
|
|
29
|
-
|
|
30
|
-
## 8. Prerequisites and Access
|
|
31
|
-
- Required tools
|
|
32
|
-
- Required permissions or credentials
|
|
33
|
-
- Safety checks before making changes
|
|
34
|
-
|
|
35
|
-
## 9. Release / Deployment Procedure
|
|
36
|
-
1. Step 1
|
|
37
|
-
2. Step 2
|
|
38
|
-
3. Step 3
|
|
39
|
-
|
|
40
|
-
## 10. Verification / Smoke Checks
|
|
41
|
-
Checks to run to ensure deployment is healthy.
|
|
42
|
-
|
|
43
|
-
## 11. Rollback / Recovery
|
|
44
|
-
Steps to recover from a failed deployment. Flowcharts are preferred. Use mermaid.
|
|
45
|
-
|
|
46
|
-
```mermaid
|
|
47
|
-
graph TD
|
|
48
|
-
A[Failure Detected] --> B[Trigger Rollback]
|
|
49
|
-
B --> C[Verify Previous State]
|
|
50
|
-
```
|
|
51
|
-
|
|
52
|
-
## 12. Operational Notes
|
|
53
|
-
Known gotchas.
|
|
54
|
-
|
|
55
|
-
## 13. Success Metrics
|
|
56
|
-
How we measure if the goals of this document are achieved.
|
|
57
|
-
|
|
58
|
-
## 14. Related Documents
|
|
59
|
-
[Link to related document](path) - Short brief note about why it's related.
|
|
60
|
-
|
|
61
|
-
## 15. Open Questions
|
|
62
|
-
Any unresolved questions or assumptions. Can be empty.
|
|
@@ -1,49 +0,0 @@
|
|
|
1
|
-
# Security
|
|
2
|
-
|
|
3
|
-
Last update: YYYY-MM-DD
|
|
4
|
-
|
|
5
|
-
Status: [Proposed | Draft | Live | Deprecated | Archived]
|
|
6
|
-
|
|
7
|
-
---
|
|
8
|
-
|
|
9
|
-
## 1. Description
|
|
10
|
-
Briefly describe the purpose of this document and what it contains.
|
|
11
|
-
|
|
12
|
-
## 2. Important
|
|
13
|
-
Notes of important findings or critical constraints. Can be empty.
|
|
14
|
-
|
|
15
|
-
## 3. Table of Contents
|
|
16
|
-
[Generate a hyperlinked table of contents here containing ALL headings in this file (1 through N). Use standard markdown links, e.g., - [1. Description](#1-description)]
|
|
17
|
-
|
|
18
|
-
## 4. Scope
|
|
19
|
-
The boundaries of what this document covers.
|
|
20
|
-
|
|
21
|
-
## 5. Goals
|
|
22
|
-
What we aim to achieve with this specific document.
|
|
23
|
-
|
|
24
|
-
## 6. Non Goals
|
|
25
|
-
What is explicitly excluded from the scope of this document.
|
|
26
|
-
|
|
27
|
-
## 7. Security Objectives
|
|
28
|
-
Primary assets to protect.
|
|
29
|
-
|
|
30
|
-
## 8. Identified Threats & Vectors
|
|
31
|
-
Known vulnerabilities (e.g., injection, XSS, DDOS).
|
|
32
|
-
|
|
33
|
-
## 9. Mitigation Strategies
|
|
34
|
-
How the architecture neutralizes the threats.
|
|
35
|
-
|
|
36
|
-
## 10. Access Control (RBAC)
|
|
37
|
-
Roles, permissions, and session management.
|
|
38
|
-
|
|
39
|
-
## 11. Data Encryption (At-Rest / In-Transit)
|
|
40
|
-
Algorithms and key management.
|
|
41
|
-
|
|
42
|
-
## 12. Success Metrics
|
|
43
|
-
How we measure if the goals of this document are achieved.
|
|
44
|
-
|
|
45
|
-
## 13. Related Documents
|
|
46
|
-
[Link to related document](path) - Short brief note about why it's related.
|
|
47
|
-
|
|
48
|
-
## 14. Open Questions
|
|
49
|
-
Any unresolved questions or assumptions. Can be empty.
|
|
@@ -1,49 +0,0 @@
|
|
|
1
|
-
# API Contract
|
|
2
|
-
|
|
3
|
-
Last update: YYYY-MM-DD
|
|
4
|
-
|
|
5
|
-
Status: [Proposed | Draft | Live | Deprecated | Archived]
|
|
6
|
-
|
|
7
|
-
---
|
|
8
|
-
|
|
9
|
-
## 1. Description
|
|
10
|
-
Briefly describe the purpose of this document and what it contains.
|
|
11
|
-
|
|
12
|
-
## 2. Important
|
|
13
|
-
Notes of important findings or critical constraints. Can be empty.
|
|
14
|
-
|
|
15
|
-
## 3. Table of Contents
|
|
16
|
-
[Generate a hyperlinked table of contents here containing ALL headings in this file (1 through N). Use standard markdown links, e.g., - [1. Description](#1-description)]
|
|
17
|
-
|
|
18
|
-
## 4. Scope
|
|
19
|
-
The boundaries of what this document covers.
|
|
20
|
-
|
|
21
|
-
## 5. Goals
|
|
22
|
-
What we aim to achieve with this specific document.
|
|
23
|
-
|
|
24
|
-
## 6. Non Goals
|
|
25
|
-
What is explicitly excluded from the scope of this document.
|
|
26
|
-
|
|
27
|
-
## 7. Base URL & Authentication
|
|
28
|
-
Core connection details and token requirements.
|
|
29
|
-
|
|
30
|
-
## 8. Standard Request/Response Format
|
|
31
|
-
The expected shape of data (e.g., standard JSON wrapper).
|
|
32
|
-
|
|
33
|
-
## 9. Endpoints (REST / GraphQL)
|
|
34
|
-
Specific routes, methods, payloads, and responses.
|
|
35
|
-
|
|
36
|
-
## 10. Webhooks & Events
|
|
37
|
-
Outbound data events pushed to external systems.
|
|
38
|
-
|
|
39
|
-
## 11. Rate Limiting & Constraints
|
|
40
|
-
Throttling rules and payload size limits.
|
|
41
|
-
|
|
42
|
-
## 12. Success Metrics
|
|
43
|
-
How we measure if the goals of this document are achieved.
|
|
44
|
-
|
|
45
|
-
## 13. Related Documents
|
|
46
|
-
[Link to related document](path) - Short brief note about why it's related.
|
|
47
|
-
|
|
48
|
-
## 14. Open Questions
|
|
49
|
-
Any unresolved questions or assumptions. Can be empty.
|
|
@@ -1,59 +0,0 @@
|
|
|
1
|
-
# Database Schema
|
|
2
|
-
|
|
3
|
-
Last update: YYYY-MM-DD
|
|
4
|
-
|
|
5
|
-
Status: [Proposed | Draft | Live | Deprecated | Archived]
|
|
6
|
-
|
|
7
|
-
---
|
|
8
|
-
|
|
9
|
-
## 1. Description
|
|
10
|
-
Briefly describe the purpose of this document and what it contains.
|
|
11
|
-
|
|
12
|
-
## 2. Important
|
|
13
|
-
Notes of important findings or critical constraints. Can be empty.
|
|
14
|
-
|
|
15
|
-
## 3. Table of Contents
|
|
16
|
-
[Generate a hyperlinked table of contents here containing ALL headings in this file (1 through N). Use standard markdown links, e.g., - [1. Description](#1-description)]
|
|
17
|
-
|
|
18
|
-
## 4. Scope
|
|
19
|
-
The boundaries of what this document covers.
|
|
20
|
-
|
|
21
|
-
## 5. Goals
|
|
22
|
-
What we aim to achieve with this specific document.
|
|
23
|
-
|
|
24
|
-
## 6. Non Goals
|
|
25
|
-
What is explicitly excluded from the scope of this document.
|
|
26
|
-
|
|
27
|
-
## 7. Database Architecture
|
|
28
|
-
Type of DB (SQL/NoSQL) and clustering details.
|
|
29
|
-
|
|
30
|
-
## 8. Entity Relationship Diagram (ERD)
|
|
31
|
-
Visual or text-based map of table relationships. ERDs are preferred. Use mermaid.
|
|
32
|
-
|
|
33
|
-
```mermaid
|
|
34
|
-
erDiagram
|
|
35
|
-
CUSTOMER ||--o{ ORDER : places
|
|
36
|
-
ORDER ||--|{ LINE-ITEM : contains
|
|
37
|
-
CUSTOMER }|..|{ DELIVERY-ADDRESS : uses
|
|
38
|
-
```
|
|
39
|
-
|
|
40
|
-
## 9. Schema Definitions (Tables/Collections)
|
|
41
|
-
Specific columns, types, and constraints.
|
|
42
|
-
|
|
43
|
-
## 10. Indexes & Performance
|
|
44
|
-
Keys required for fast lookups.
|
|
45
|
-
|
|
46
|
-
## 11. Migration Strategy
|
|
47
|
-
How schema changes are versioned and deployed.
|
|
48
|
-
|
|
49
|
-
## 12. Data Dictionary
|
|
50
|
-
Single source of truth for business definitions. Define what key domain terms actually mean (e.g., "An *Active User* is someone who logged in within 30 days, excluding admins").
|
|
51
|
-
|
|
52
|
-
## 13. Success Metrics
|
|
53
|
-
How we measure if the goals of this document are achieved.
|
|
54
|
-
|
|
55
|
-
## 14. Related Documents
|
|
56
|
-
[Link to related document](path) - Short brief note about why it's related.
|
|
57
|
-
|
|
58
|
-
## 15. Open Questions
|
|
59
|
-
Any unresolved questions or assumptions. Can be empty.
|
|
@@ -1,54 +0,0 @@
|
|
|
1
|
-
# Error Handling
|
|
2
|
-
|
|
3
|
-
Last update: YYYY-MM-DD
|
|
4
|
-
|
|
5
|
-
Status: [Proposed | Draft | Live | Deprecated | Archived]
|
|
6
|
-
|
|
7
|
-
---
|
|
8
|
-
|
|
9
|
-
## 1. Description
|
|
10
|
-
Briefly describe the purpose of this document and what it contains.
|
|
11
|
-
|
|
12
|
-
## 2. Important
|
|
13
|
-
Notes of important findings or critical constraints. Can be empty.
|
|
14
|
-
|
|
15
|
-
## 3. Table of Contents
|
|
16
|
-
[Generate a hyperlinked table of contents here containing ALL headings in this file (1 through N). Use standard markdown links, e.g., - [1. Description](#1-description)]
|
|
17
|
-
|
|
18
|
-
## 4. Scope
|
|
19
|
-
The boundaries of what this document covers.
|
|
20
|
-
|
|
21
|
-
## 5. Goals
|
|
22
|
-
What we aim to achieve with this specific document.
|
|
23
|
-
|
|
24
|
-
## 6. Non Goals
|
|
25
|
-
What is explicitly excluded from the scope of this document.
|
|
26
|
-
|
|
27
|
-
## 7. Standard Error Payload
|
|
28
|
-
The exact JSON shape returned on failure.
|
|
29
|
-
|
|
30
|
-
## 8. Global Error Codes
|
|
31
|
-
A registry of specific business logic errors.
|
|
32
|
-
|
|
33
|
-
## 9. Client-Side Handling Rules
|
|
34
|
-
How the frontend should display or retry failures.
|
|
35
|
-
|
|
36
|
-
## 10. Server-Side Fallbacks
|
|
37
|
-
Circuit breakers and degraded modes. Diagram of fallback flow is preferred. Use mermaid.
|
|
38
|
-
|
|
39
|
-
```mermaid
|
|
40
|
-
graph TD
|
|
41
|
-
A[Request] --> B{Service Online?}
|
|
42
|
-
B -- Yes --> C[Process Request]
|
|
43
|
-
B -- No --> D[Trigger Circuit Breaker]
|
|
44
|
-
D --> E[Return Fallback Payload]
|
|
45
|
-
```
|
|
46
|
-
|
|
47
|
-
## 11. Success Metrics
|
|
48
|
-
How we measure if the goals of this document are achieved.
|
|
49
|
-
|
|
50
|
-
## 12. Related Documents
|
|
51
|
-
[Link to related document](path) - Short brief note about why it's related.
|
|
52
|
-
|
|
53
|
-
## 13. Open Questions
|
|
54
|
-
Any unresolved questions or assumptions. Can be empty.
|
|
@@ -1,46 +0,0 @@
|
|
|
1
|
-
# Internationalization & Localization
|
|
2
|
-
|
|
3
|
-
Last update: YYYY-MM-DD
|
|
4
|
-
|
|
5
|
-
Status: [Proposed | Draft | Live | Deprecated | Archived]
|
|
6
|
-
|
|
7
|
-
---
|
|
8
|
-
|
|
9
|
-
## 1. Description
|
|
10
|
-
Briefly describe the purpose of this document and what it contains.
|
|
11
|
-
|
|
12
|
-
## 2. Important
|
|
13
|
-
Notes of important findings or critical constraints. Can be empty.
|
|
14
|
-
|
|
15
|
-
## 3. Table of Contents
|
|
16
|
-
[Generate a hyperlinked table of contents here containing ALL headings in this file (1 through N). Use standard markdown links, e.g., - [1. Description](#1-description)]
|
|
17
|
-
|
|
18
|
-
## 4. Scope
|
|
19
|
-
The boundaries of what this document covers.
|
|
20
|
-
|
|
21
|
-
## 5. Goals
|
|
22
|
-
What we aim to achieve with this specific document.
|
|
23
|
-
|
|
24
|
-
## 6. Non Goals
|
|
25
|
-
What is explicitly excluded from the scope of this document.
|
|
26
|
-
|
|
27
|
-
## 7. Supported Languages / Locales
|
|
28
|
-
The explicit list of target regions.
|
|
29
|
-
|
|
30
|
-
## 8. Translation Workflow (TMS)
|
|
31
|
-
How strings are extracted, translated, and merged.
|
|
32
|
-
|
|
33
|
-
## 9. Fallback Locales
|
|
34
|
-
The default language when a string is missing.
|
|
35
|
-
|
|
36
|
-
## 10. Date & Currency Formats
|
|
37
|
-
Regional formatting rules.
|
|
38
|
-
|
|
39
|
-
## 11. Success Metrics
|
|
40
|
-
How we measure if the goals of this document are achieved.
|
|
41
|
-
|
|
42
|
-
## 12. Related Documents
|
|
43
|
-
[Link to related document](path) - Short brief note about why it's related.
|
|
44
|
-
|
|
45
|
-
## 13. Open Questions
|
|
46
|
-
Any unresolved questions or assumptions. Can be empty.
|
|
@@ -1,57 +0,0 @@
|
|
|
1
|
-
# Testing & Verification
|
|
2
|
-
|
|
3
|
-
Last update: YYYY-MM-DD
|
|
4
|
-
|
|
5
|
-
Status: [Proposed | Draft | Live | Deprecated | Archived]
|
|
6
|
-
|
|
7
|
-
---
|
|
8
|
-
|
|
9
|
-
## 1. Description
|
|
10
|
-
Briefly describe the purpose of this document and what it contains.
|
|
11
|
-
|
|
12
|
-
## 2. Important
|
|
13
|
-
Notes of important findings or critical constraints. Can be empty.
|
|
14
|
-
|
|
15
|
-
## 3. Table of Contents
|
|
16
|
-
[Generate a hyperlinked table of contents here containing ALL headings in this file (1 through N). Use standard markdown links, e.g., - [1. Description](#1-description)]
|
|
17
|
-
|
|
18
|
-
## 4. Scope
|
|
19
|
-
The boundaries of what this document covers.
|
|
20
|
-
|
|
21
|
-
## 5. Goals
|
|
22
|
-
What we aim to achieve with this specific document.
|
|
23
|
-
|
|
24
|
-
## 6. Non Goals
|
|
25
|
-
What is explicitly excluded from the scope of this document.
|
|
26
|
-
|
|
27
|
-
## 7. Verification Policy & Objectives
|
|
28
|
-
Define the overarching philosophy for how this repository chooses, runs, and reports testing. What are we trying to prove with our test suite?
|
|
29
|
-
|
|
30
|
-
## 8. Verification Matrix & Coverage
|
|
31
|
-
The required types of testing (Blackbox, Unit, Security) mapping against expected coverage metrics (e.g., 85% branch coverage).
|
|
32
|
-
|
|
33
|
-
| Change type | Preferred validation | Fallback |
|
|
34
|
-
| --- | --- | --- |
|
|
35
|
-
| Code change | TBD | TBD |
|
|
36
|
-
| Documentation change | TBD | TBD |
|
|
37
|
-
|
|
38
|
-
## 9. Test Layers & Environments
|
|
39
|
-
Detail the exact split of Unit, Component, Integration, and E2E tests. Include the required infrastructure, mocks, and seed data needed to run them.
|
|
40
|
-
|
|
41
|
-
## 10. Commands & CI Gates
|
|
42
|
-
The exact terminal commands for linting and testing. Outline the required pre-merge CI checks (blocking vs advisory).
|
|
43
|
-
|
|
44
|
-
## 11. Naming & File Conventions
|
|
45
|
-
Where tests live, how test files are named (e.g., `*.spec.ts`), and how fixtures are stored.
|
|
46
|
-
|
|
47
|
-
## 12. Manual Checks & Fallbacks
|
|
48
|
-
Necessary manual testing steps and fallback procedures for human verification when automation is impossible.
|
|
49
|
-
|
|
50
|
-
## 13. Success Metrics
|
|
51
|
-
How we measure if the goals of this document are achieved.
|
|
52
|
-
|
|
53
|
-
## 14. Related Documents
|
|
54
|
-
[Link to related document](path) - Short brief note about why it's related.
|
|
55
|
-
|
|
56
|
-
## 15. Open Questions
|
|
57
|
-
Any unresolved questions or assumptions. Can be empty.
|
|
@@ -1,68 +0,0 @@
|
|
|
1
|
-
# UI/UX
|
|
2
|
-
|
|
3
|
-
Last update: YYYY-MM-DD
|
|
4
|
-
|
|
5
|
-
Status: [Proposed | Draft | Live | Deprecated | Archived]
|
|
6
|
-
|
|
7
|
-
---
|
|
8
|
-
|
|
9
|
-
## 1. Description
|
|
10
|
-
Briefly describe the purpose of this document and what it contains.
|
|
11
|
-
|
|
12
|
-
## 2. Important
|
|
13
|
-
Notes of important findings or critical constraints. Can be empty.
|
|
14
|
-
|
|
15
|
-
## 3. Table of Contents
|
|
16
|
-
[Generate a hyperlinked table of contents here containing ALL headings in this file (1 through N). Use standard markdown links, e.g., - [1. Description](#1-description)]
|
|
17
|
-
|
|
18
|
-
## 4. Scope
|
|
19
|
-
The boundaries of what this document covers.
|
|
20
|
-
|
|
21
|
-
## 5. Goals
|
|
22
|
-
What we aim to achieve with this specific document.
|
|
23
|
-
|
|
24
|
-
## 6. Non Goals
|
|
25
|
-
What is explicitly excluded from the scope of this document.
|
|
26
|
-
|
|
27
|
-
## 7. Design Philosophy
|
|
28
|
-
The core principles guiding the user experience.
|
|
29
|
-
|
|
30
|
-
## 8. Design System & Theme
|
|
31
|
-
Colors, typography, and visual guidelines.
|
|
32
|
-
|
|
33
|
-
## 9. Wireframing & Prototyping
|
|
34
|
-
Links to external tools (Figma, Adobe) or raw UI specs generated by humans/AI in the repo.
|
|
35
|
-
|
|
36
|
-
## 10. Screen Layouts
|
|
37
|
-
Core page structures and navigation flows. Wireframes are preferred. Use mermaid.
|
|
38
|
-
|
|
39
|
-
```mermaid
|
|
40
|
-
graph TD
|
|
41
|
-
A[Home Page] --> B[Dashboard]
|
|
42
|
-
A --> C[Profile Settings]
|
|
43
|
-
B --> D[Details View]
|
|
44
|
-
```
|
|
45
|
-
|
|
46
|
-
## 11. Component Library
|
|
47
|
-
Reusable UI elements (buttons, modals).
|
|
48
|
-
|
|
49
|
-
## 12. Responsive Breakpoints
|
|
50
|
-
Behavior across mobile, tablet, and desktop.
|
|
51
|
-
|
|
52
|
-
## 13. Accessibility (a11y) Requirements
|
|
53
|
-
Contrast ratios, ARIA labels.
|
|
54
|
-
|
|
55
|
-
## 14. Implementation Backlog
|
|
56
|
-
List of UI tasks (e.g., `Task-ID: Description`).
|
|
57
|
-
|
|
58
|
-
## 15. Design Handoff Approaches
|
|
59
|
-
How designs are explicitly transferred to developers.
|
|
60
|
-
|
|
61
|
-
## 16. Success Metrics
|
|
62
|
-
How we measure if the goals of this document are achieved.
|
|
63
|
-
|
|
64
|
-
## 17. Related Documents
|
|
65
|
-
[Link to related document](path) - Short brief note about why it's related.
|
|
66
|
-
|
|
67
|
-
## 18. Open Questions
|
|
68
|
-
Any unresolved questions or assumptions. Can be empty.
|
|
@@ -1,14 +0,0 @@
|
|
|
1
|
-
# Database Schema Design Skill
|
|
2
|
-
|
|
3
|
-
You are an expert Database Architect. Your task is to design robust, scalable, and normalized database schemas (or optimized NoSQL data models) based on the project's requirements.
|
|
4
|
-
|
|
5
|
-
## Responsibilities
|
|
6
|
-
1. Analyze `docs/project-docs/foundation/prd.md` to understand data storage needs.
|
|
7
|
-
2. Design tables/collections, defining strict types, primary keys, and foreign keys.
|
|
8
|
-
3. Establish proper indexes for common query patterns to ensure high performance.
|
|
9
|
-
4. Document the relationships (1:1, 1:N, M:N) clearly in `docs/project-docs/technical/database.md`.
|
|
10
|
-
|
|
11
|
-
## Output Constraints
|
|
12
|
-
- Always use standard Entity-Relationship terminology.
|
|
13
|
-
- When generating SQL schemas, prefer standard ANSI SQL unless a specific dialect (e.g., PostgreSQL, MySQL) is requested.
|
|
14
|
-
- Highlight any potential bottlenecks (e.g., heavily joined tables, wide rows).
|