@sallmarta/eye-hate-agent 1.0.2 → 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.
Files changed (74) hide show
  1. package/README.md +56 -304
  2. package/bin/eha.js +203 -118
  3. package/docs/templates/project-docs-template/index.md +208 -0
  4. package/docs/templates/project-docs-template/technical-guidelines/index.md +81 -0
  5. package/docs/templates/reusable-prompts/00-project-docs-bootstrap.md +40 -0
  6. package/docs/{vibes → templates}/reusable-prompts/00-project-docs-parity.md +4 -6
  7. package/docs/{vibes → templates}/reusable-prompts/00-project-docs-refresh.md +11 -11
  8. package/docs/{vibes → templates}/reusable-prompts/01-sdd-execute.md +1 -1
  9. package/docs/{vibes → templates}/reusable-prompts/02-sdd-discuss.md +3 -3
  10. package/{.agents/rules/agent.md → docs/templates/rules/agent-rules.md} +7 -12
  11. package/docs/{vibes → templates}/skills/api-design/SKILL.md +14 -25
  12. package/docs/{vibes/skills/full-verification → templates/skills/code-audit}/SKILL.md +36 -54
  13. package/docs/templates/skills/db-schema-design/SKILL.md +120 -0
  14. package/docs/templates/skills/devops-ci-cd/SKILL.md +99 -0
  15. package/docs/templates/skills/observability/SKILL.md +99 -0
  16. package/docs/{vibes/skills/parity → templates/skills/parity-audit}/SKILL.md +26 -52
  17. package/docs/templates/skills/refactor/SKILL.md +100 -0
  18. package/docs/templates/skills/security-audit/SKILL.md +149 -0
  19. package/docs/{vibes/skills/analysis → templates/skills/system-analysis}/SKILL.md +19 -41
  20. package/docs/{vibes/skills/test-authoring → templates/skills/system-tester}/SKILL.md +28 -46
  21. package/docs/templates/skills/ui-ux-design/SKILL.md +102 -0
  22. package/docs/templates/skills/wireframing/SKILL.md +88 -0
  23. package/package.json +4 -6
  24. package/src/engine/index.js +9 -12
  25. package/src/engine/install.js +67 -165
  26. package/src/engine/runtime-adapters.js +266 -50
  27. package/src/engine/skill-registry.js +72 -0
  28. package/src/engine/state.js +29 -7
  29. package/src/engine/workflow-registry.js +14 -23
  30. package/.claude/commands/eha/README.md +0 -3
  31. package/.claude/commands/eha/eha-bootstrap.md +0 -9
  32. package/.claude/commands/eha/eha-discuss.md +0 -9
  33. package/.claude/commands/eha/eha-execute.md +0 -9
  34. package/.claude/commands/eha/eha-parity.md +0 -9
  35. package/.claude/commands/eha/eha-refresh.md +0 -9
  36. package/.claude/commands/eha/eha-verify.md +0 -9
  37. package/.claude/rules/agent-rules.md +0 -64
  38. package/.github/instructions/agent-rules.instructions.md +0 -63
  39. package/.github/instructions/eha-workflows.instructions.md +0 -21
  40. package/docs/eyehateagent-contract.md +0 -475
  41. package/docs/eyehateagent-maintenance.md +0 -103
  42. package/docs/project-docs/changelog.md +0 -299
  43. package/docs/project-docs/foundation/architecture.md +0 -117
  44. package/docs/project-docs/foundation/status.md +0 -32
  45. package/docs/project-docs/foundation/workflow.md +0 -63
  46. package/docs/project-docs/index.md +0 -20
  47. package/docs/project-docs/testing.md +0 -73
  48. package/docs/vibes/project-docs-template/foundation/architecture.md +0 -79
  49. package/docs/vibes/project-docs-template/foundation/changelog.md +0 -53
  50. package/docs/vibes/project-docs-template/foundation/feature-inventory.md +0 -46
  51. package/docs/vibes/project-docs-template/foundation/phases.md +0 -60
  52. package/docs/vibes/project-docs-template/foundation/prd.md +0 -69
  53. package/docs/vibes/project-docs-template/foundation/status.md +0 -57
  54. package/docs/vibes/project-docs-template/foundation/workflow.md +0 -59
  55. package/docs/vibes/project-docs-template/getting-started.md +0 -52
  56. package/docs/vibes/project-docs-template/index.md +0 -66
  57. package/docs/vibes/project-docs-template/operations/ci-cd.md +0 -56
  58. package/docs/vibes/project-docs-template/operations/compliance.md +0 -46
  59. package/docs/vibes/project-docs-template/operations/governance.md +0 -46
  60. package/docs/vibes/project-docs-template/operations/observability.md +0 -53
  61. package/docs/vibes/project-docs-template/operations/production-runbook.md +0 -62
  62. package/docs/vibes/project-docs-template/operations/security.md +0 -49
  63. package/docs/vibes/project-docs-template/technical/api-contract.md +0 -49
  64. package/docs/vibes/project-docs-template/technical/database.md +0 -59
  65. package/docs/vibes/project-docs-template/technical/error-handling.md +0 -54
  66. package/docs/vibes/project-docs-template/technical/internationalization.md +0 -46
  67. package/docs/vibes/project-docs-template/technical/testing.md +0 -57
  68. package/docs/vibes/project-docs-template/technical/ui-ux.md +0 -68
  69. package/docs/vibes/project-docs-template/technical-guidelines/index.md +0 -52
  70. package/docs/vibes/reusable-prompts/00-project-docs-bootstrap.md +0 -59
  71. package/docs/vibes/skills/code-audit/SKILL.md +0 -170
  72. package/docs/vibes/skills/project-elevation/SKILL.md +0 -157
  73. package/docs/vibes/skills/test-authoring/references/patterns.md +0 -116
  74. package/docs/vibes/skills/test-authoring/references/test-types.md +0 -52
@@ -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
- > [!NOTE] Briefly describe the purpose of this document and what it contains.
11
-
12
- ## 2. Important
13
- > [!NOTE] Notes of important findings or critical constraints. Can be empty.
14
-
15
- ## 3. Table of Contents
16
- > [!NOTE] TOC goes here.
17
-
18
- ## 4. Scope
19
- > [!NOTE] The boundaries of what this document covers.
20
-
21
- ## 5. Goals
22
- > [!NOTE] What we aim to achieve with this specific document.
23
-
24
- ## 6. Non Goals
25
- > [!NOTE] What is explicitly excluded from the scope of this document.
26
-
27
- ## 7. Logging Strategy & Levels
28
- > [!NOTE] Formatting (e.g., JSON) and severity rules (Info/Warn/Error).
29
-
30
- ## 8. Metrics & Dashboards
31
- > [!NOTE] Key Performance Indicators (latency, error rates).
32
-
33
- ## 9. Distributed Tracing
34
- > [!NOTE] Request IDs and flow mapping across microservices.
35
-
36
- ## 10. Alerting Rules & Thresholds
37
- > [!NOTE] 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
- > [!NOTE] How we measure if the goals of this document are achieved.
48
-
49
- ## 12. Related Documents
50
- > [!NOTE] [Link to related document](path) - Short brief note about why it's related.
51
-
52
- ## 13. Open Questions
53
- > [!NOTE] 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
- > [!NOTE] Describe what this runbook covers and which environment or service it applies to.
11
-
12
- ## 2. Important
13
- > [!NOTE] Notes of important findings or critical constraints. Can be empty.
14
-
15
- ## 3. Table of Contents
16
- > [!NOTE] TOC goes here.
17
-
18
- ## 4. Scope
19
- > [!NOTE] The boundaries of what this document covers.
20
-
21
- ## 5. Goals
22
- > [!NOTE] What we aim to achieve with this specific document.
23
-
24
- ## 6. Non Goals
25
- > [!NOTE] What is explicitly excluded from the scope of this document.
26
-
27
- ## 7. Environment Overview
28
- > [!NOTE] 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
- > [!NOTE] Checks to run to ensure deployment is healthy.
42
-
43
- ## 11. Rollback / Recovery
44
- > [!NOTE] 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
- > [!NOTE] Known gotchas.
54
-
55
- ## 13. Success Metrics
56
- > [!NOTE] How we measure if the goals of this document are achieved.
57
-
58
- ## 14. Related Documents
59
- > [!NOTE] [Link to related document](path) - Short brief note about why it's related.
60
-
61
- ## 15. Open Questions
62
- > [!NOTE] 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
- > [!NOTE] Briefly describe the purpose of this document and what it contains.
11
-
12
- ## 2. Important
13
- > [!NOTE] Notes of important findings or critical constraints. Can be empty.
14
-
15
- ## 3. Table of Contents
16
- > [!NOTE] TOC goes here.
17
-
18
- ## 4. Scope
19
- > [!NOTE] The boundaries of what this document covers.
20
-
21
- ## 5. Goals
22
- > [!NOTE] What we aim to achieve with this specific document.
23
-
24
- ## 6. Non Goals
25
- > [!NOTE] What is explicitly excluded from the scope of this document.
26
-
27
- ## 7. Security Objectives
28
- > [!NOTE] Primary assets to protect.
29
-
30
- ## 8. Identified Threats & Vectors
31
- > [!NOTE] Known vulnerabilities (e.g., injection, XSS, DDOS).
32
-
33
- ## 9. Mitigation Strategies
34
- > [!NOTE] How the architecture neutralizes the threats.
35
-
36
- ## 10. Access Control (RBAC)
37
- > [!NOTE] Roles, permissions, and session management.
38
-
39
- ## 11. Data Encryption (At-Rest / In-Transit)
40
- > [!NOTE] Algorithms and key management.
41
-
42
- ## 12. Success Metrics
43
- > [!NOTE] How we measure if the goals of this document are achieved.
44
-
45
- ## 13. Related Documents
46
- > [!NOTE] [Link to related document](path) - Short brief note about why it's related.
47
-
48
- ## 14. Open Questions
49
- > [!NOTE] 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
- > [!NOTE] Briefly describe the purpose of this document and what it contains.
11
-
12
- ## 2. Important
13
- > [!NOTE] Notes of important findings or critical constraints. Can be empty.
14
-
15
- ## 3. Table of Contents
16
- > [!NOTE] TOC goes here.
17
-
18
- ## 4. Scope
19
- > [!NOTE] The boundaries of what this document covers.
20
-
21
- ## 5. Goals
22
- > [!NOTE] What we aim to achieve with this specific document.
23
-
24
- ## 6. Non Goals
25
- > [!NOTE] What is explicitly excluded from the scope of this document.
26
-
27
- ## 7. Base URL & Authentication
28
- > [!NOTE] Core connection details and token requirements.
29
-
30
- ## 8. Standard Request/Response Format
31
- > [!NOTE] The expected shape of data (e.g., standard JSON wrapper).
32
-
33
- ## 9. Endpoints (REST / GraphQL)
34
- > [!NOTE] Specific routes, methods, payloads, and responses.
35
-
36
- ## 10. Webhooks & Events
37
- > [!NOTE] Outbound data events pushed to external systems.
38
-
39
- ## 11. Rate Limiting & Constraints
40
- > [!NOTE] Throttling rules and payload size limits.
41
-
42
- ## 12. Success Metrics
43
- > [!NOTE] How we measure if the goals of this document are achieved.
44
-
45
- ## 13. Related Documents
46
- > [!NOTE] [Link to related document](path) - Short brief note about why it's related.
47
-
48
- ## 14. Open Questions
49
- > [!NOTE] 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
- > [!NOTE] Briefly describe the purpose of this document and what it contains.
11
-
12
- ## 2. Important
13
- > [!NOTE] Notes of important findings or critical constraints. Can be empty.
14
-
15
- ## 3. Table of Contents
16
- > [!NOTE] TOC goes here.
17
-
18
- ## 4. Scope
19
- > [!NOTE] The boundaries of what this document covers.
20
-
21
- ## 5. Goals
22
- > [!NOTE] What we aim to achieve with this specific document.
23
-
24
- ## 6. Non Goals
25
- > [!NOTE] What is explicitly excluded from the scope of this document.
26
-
27
- ## 7. Database Architecture
28
- > [!NOTE] Type of DB (SQL/NoSQL) and clustering details.
29
-
30
- ## 8. Entity Relationship Diagram (ERD)
31
- > [!NOTE] 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
- > [!NOTE] Specific columns, types, and constraints.
42
-
43
- ## 10. Indexes & Performance
44
- > [!NOTE] Keys required for fast lookups.
45
-
46
- ## 11. Migration Strategy
47
- > [!NOTE] How schema changes are versioned and deployed.
48
-
49
- ## 12. Data Dictionary
50
- > [!NOTE] 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
- > [!NOTE] How we measure if the goals of this document are achieved.
54
-
55
- ## 14. Related Documents
56
- > [!NOTE] [Link to related document](path) - Short brief note about why it's related.
57
-
58
- ## 15. Open Questions
59
- > [!NOTE] 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
- > [!NOTE] Briefly describe the purpose of this document and what it contains.
11
-
12
- ## 2. Important
13
- > [!NOTE] Notes of important findings or critical constraints. Can be empty.
14
-
15
- ## 3. Table of Contents
16
- > [!NOTE] TOC goes here.
17
-
18
- ## 4. Scope
19
- > [!NOTE] The boundaries of what this document covers.
20
-
21
- ## 5. Goals
22
- > [!NOTE] What we aim to achieve with this specific document.
23
-
24
- ## 6. Non Goals
25
- > [!NOTE] What is explicitly excluded from the scope of this document.
26
-
27
- ## 7. Standard Error Payload
28
- > [!NOTE] The exact JSON shape returned on failure.
29
-
30
- ## 8. Global Error Codes
31
- > [!NOTE] A registry of specific business logic errors.
32
-
33
- ## 9. Client-Side Handling Rules
34
- > [!NOTE] How the frontend should display or retry failures.
35
-
36
- ## 10. Server-Side Fallbacks
37
- > [!NOTE] 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
- > [!NOTE] How we measure if the goals of this document are achieved.
49
-
50
- ## 12. Related Documents
51
- > [!NOTE] [Link to related document](path) - Short brief note about why it's related.
52
-
53
- ## 13. Open Questions
54
- > [!NOTE] 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
- > [!NOTE] Briefly describe the purpose of this document and what it contains.
11
-
12
- ## 2. Important
13
- > [!NOTE] Notes of important findings or critical constraints. Can be empty.
14
-
15
- ## 3. Table of Contents
16
- > [!NOTE] TOC goes here.
17
-
18
- ## 4. Scope
19
- > [!NOTE] The boundaries of what this document covers.
20
-
21
- ## 5. Goals
22
- > [!NOTE] What we aim to achieve with this specific document.
23
-
24
- ## 6. Non Goals
25
- > [!NOTE] What is explicitly excluded from the scope of this document.
26
-
27
- ## 7. Supported Languages / Locales
28
- > [!NOTE] The explicit list of target regions.
29
-
30
- ## 8. Translation Workflow (TMS)
31
- > [!NOTE] How strings are extracted, translated, and merged.
32
-
33
- ## 9. Fallback Locales
34
- > [!NOTE] The default language when a string is missing.
35
-
36
- ## 10. Date & Currency Formats
37
- > [!NOTE] Regional formatting rules.
38
-
39
- ## 11. Success Metrics
40
- > [!NOTE] How we measure if the goals of this document are achieved.
41
-
42
- ## 12. Related Documents
43
- > [!NOTE] [Link to related document](path) - Short brief note about why it's related.
44
-
45
- ## 13. Open Questions
46
- > [!NOTE] 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
- > [!NOTE] Briefly describe the purpose of this document and what it contains.
11
-
12
- ## 2. Important
13
- > [!NOTE] Notes of important findings or critical constraints. Can be empty.
14
-
15
- ## 3. Table of Contents
16
- > [!NOTE] TOC goes here.
17
-
18
- ## 4. Scope
19
- > [!NOTE] The boundaries of what this document covers.
20
-
21
- ## 5. Goals
22
- > [!NOTE] What we aim to achieve with this specific document.
23
-
24
- ## 6. Non Goals
25
- > [!NOTE] What is explicitly excluded from the scope of this document.
26
-
27
- ## 7. Verification Policy & Objectives
28
- > [!NOTE] 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
- > [!NOTE] 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
- > [!NOTE] 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
- > [!NOTE] 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
- > [!NOTE] Where tests live, how test files are named (e.g., `*.spec.ts`), and how fixtures are stored.
46
-
47
- ## 12. Manual Checks & Fallbacks
48
- > [!NOTE] Necessary manual testing steps and fallback procedures for human verification when automation is impossible.
49
-
50
- ## 13. Success Metrics
51
- > [!NOTE] How we measure if the goals of this document are achieved.
52
-
53
- ## 14. Related Documents
54
- > [!NOTE] [Link to related document](path) - Short brief note about why it's related.
55
-
56
- ## 15. Open Questions
57
- > [!NOTE] 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
- > [!NOTE] Briefly describe the purpose of this document and what it contains.
11
-
12
- ## 2. Important
13
- > [!NOTE] Notes of important findings or critical constraints. Can be empty.
14
-
15
- ## 3. Table of Contents
16
- > [!NOTE] TOC goes here.
17
-
18
- ## 4. Scope
19
- > [!NOTE] The boundaries of what this document covers.
20
-
21
- ## 5. Goals
22
- > [!NOTE] What we aim to achieve with this specific document.
23
-
24
- ## 6. Non Goals
25
- > [!NOTE] What is explicitly excluded from the scope of this document.
26
-
27
- ## 7. Design Philosophy
28
- > [!NOTE] The core principles guiding the user experience.
29
-
30
- ## 8. Design System & Theme
31
- > [!NOTE] Colors, typography, and visual guidelines.
32
-
33
- ## 9. Wireframing & Prototyping
34
- > [!NOTE] Links to external tools (Figma, Adobe) or raw UI specs generated by humans/AI in the repo.
35
-
36
- ## 10. Screen Layouts
37
- > [!NOTE] 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
- > [!NOTE] Reusable UI elements (buttons, modals).
48
-
49
- ## 12. Responsive Breakpoints
50
- > [!NOTE] Behavior across mobile, tablet, and desktop.
51
-
52
- ## 13. Accessibility (a11y) Requirements
53
- > [!NOTE] Contrast ratios, ARIA labels.
54
-
55
- ## 14. Implementation Backlog
56
- > [!NOTE] List of UI tasks (e.g., `Task-ID: Description`).
57
-
58
- ## 15. Design Handoff Approaches
59
- > [!NOTE] How designs are explicitly transferred to developers.
60
-
61
- ## 16. Success Metrics
62
- > [!NOTE] How we measure if the goals of this document are achieved.
63
-
64
- ## 17. Related Documents
65
- > [!NOTE] [Link to related document](path) - Short brief note about why it's related.
66
-
67
- ## 18. Open Questions
68
- > [!NOTE] Any unresolved questions or assumptions. Can be empty.
@@ -1,52 +0,0 @@
1
- # Guidelines Index
2
-
3
- Last update: YYYY-MM-DD
4
-
5
- Status: [Proposed | Draft | Live | Deprecated | Archived]
6
-
7
- ---
8
-
9
- ## 1. Summary
10
- > [!NOTE] Use this index to list the active technical guideline documents for the repository. Core project docs explain the repository generally. Guidelines explain the durable technical rules that recurring implementation and review work should follow. This index is the authoritative registry for active guideline types; starter template files are recommended references, not the activation mechanism.
11
-
12
- ## 2. When To Add A Guideline
13
- - Add a guideline when a technical domain has cross-cutting rules that would otherwise be repeated across tasks.
14
- - Do not create a guideline as a placeholder.
15
- - Keep one primary domain per guideline file.
16
- - If a rule is broad project truth, keep it in the core project docs and reference that doc here instead.
17
- - Add a new row in the `## 3. Active Guidelines` table below when activating a known guideline type, even if no starter template file exists for it yet.
18
-
19
- ## 3. Active Guidelines
20
- | Guideline | Domain | Purpose | Owner | Review trigger |
21
- | --- | --- | --- | --- | --- |
22
- | `technical-guidelines/api.md` | API | Request or response contracts, versioning rules, and integration boundaries | TBD | API contract or integration changes |
23
- | `technical-guidelines/database.md` | Database | Schema, migration, naming, and persistence rules | TBD | Schema or storage changes |
24
- | `technical-guidelines/logging.md` | Logging | Event naming, log levels, redaction, and correlation rules | TBD | Logging policy or observability changes |
25
- | `technical-guidelines/error-handling.md` | Error handling | Error taxonomy, propagation, user-safe messages, and fallback rules | TBD | Error model or operational changes |
26
- | `technical-guidelines/json.md` | JSON | Serialization, naming, nullability, and payload-shape rules | TBD | Payload or contract changes |
27
- | `technical-guidelines/code-style.md` | Code style | Repo-specific style rules beyond formatter and linter defaults | TBD | Tooling or style-policy changes |
28
- | `technical-guidelines/design-patterns.md` | Design patterns | Preferred design patterns, boundary patterns, and forbidden coupling | TBD | Architecture or module-boundary changes |
29
- | `technical-guidelines/internationalization.md` | i18n/l10n | Rules for i18n keys, fallbacks, and adding new languages | TBD | i18n tooling or language changes |
30
- | `technical-guidelines/testing.md` | Testing | Rules for writing tests, naming conventions, mocking, and coverage | TBD | Testing framework or coverage changes |
31
- | `technical-guidelines/ui-ux.md` | UI/UX | Rules for UI components, accessibility standards, and design system usage | TBD | Design system or component library changes |
32
- | `technical-guidelines/your-new-guideline.md` | State the domain of the next guideline here | State the purpose of the next guideline here | TBD | State the review trigger for the next guideline here |
33
-
34
- > [!NOTE] Remove rows for inactive domains and add a new row in the `## 3. Active Guidelines` table above for any other active guideline files.
35
-
36
- ## 4. Ownership And Review
37
- - Keep this index aligned with the files that actually exist under `technical-guidelines/`.
38
- - A row in this index activates a known guideline type for bootstrap, refresh, and parity behavior.
39
- - If no starter template file exists for a listed guideline type, use the stable guideline headings from the contract.
40
- - Update the relevant row whenever a guideline changes owner, scope, or review trigger.
41
- - Cross-reference owning project docs such as `architecture.md` or `testing.md` when a guideline depends on them.
42
-
43
- ## 5. Stable Headings
44
- > [!NOTE] New guideline files must include the standard numbered headings below to keep all rulebooks consistent. Feel free to add extra domain-specific headings if needed.
45
-
46
- 1. **`## 1. Summary`**: A brief overview of what rules this guideline documents.
47
- 2. **`## 2. Scope`**: The explicit boundaries of what these rules cover (and don't cover).
48
- 3. **`## 3. Rules`**: The hard rules that must be followed.
49
- 4. **`## 4. Preferred Patterns`**: Examples or guidelines of the *best* way to do something.
50
- 5. **`## 5. Anti-Patterns`**: Examples of what *not* to do.
51
- 6. **`## 6. Related Docs`**: Links to `technical/` docs or other guidelines.
52
- 7. **`## 7. Open Questions`**: Any unresolved rules or edge cases.
@@ -1,59 +0,0 @@
1
- # Project Docs Bootstrap Reusable Prompt (v2.0.0)
2
-
3
- Read `docs/eyehateagent-contract.md` first.
4
-
5
- Generate the **initial project documentation set** for a repository.
6
- You must dynamically adjust your behavior based on the current state of the repository.
7
-
8
- ## State Detection (Universal Document Handler)
9
- Before writing any documents, analyze the workspace to determine its state:
10
- 1. **Zero Docs (Fresh Repo):** No existing documentation and no code. You must ask the user questions to build the specifications from scratch.
11
- 2. **Unclear Docs (Running Repo):** Code exists but docs are missing or outdated. Analyze the existing codebase (package files, database schemas, api routes) to reverse-engineer `foundation/architecture.md` and `technical/database.md`. Ask the user to fill in the missing product goals.
12
- 3. **Mature Docs:** Existing legacy documentation exists but isn't in the EHA format. Map the existing docs into the new 4-layer taxonomy `docs/project-docs/` format without losing historical context.
13
-
14
- ## Required Behavior
15
- 1. Follow the 4-layer file structure defined in `docs/eyehateagent-contract.md` (`foundation/`, `operations/`, `technical/`, `technical-guidelines/`).
16
- 2. Create project-specific truth in `docs/project-docs/`, not in the reusable prompt output itself.
17
- 3. Do not invent details. Mark uncertain facts as `TBD` or `Assumption`.
18
- 4. If reverse-engineering from code, explicitly state "Inferred from codebase" in the generated document until the user confirms it.
19
-
20
- ## Output Contract (The Massive Document Structure)
21
- Create these files under `docs/project-docs/`. If you lack the context to fill them out, generate the markdown headings and mark the content as TBD.
22
-
23
- **Root:**
24
- - `index.md`
25
- - `getting-started.md`
26
-
27
- **Foundation:**
28
- - `foundation/prd.md`
29
- - `foundation/architecture.md`
30
- - `foundation/workflow.md`
31
- - `foundation/status.md`
32
- - `foundation/phases.md`
33
- - `foundation/changelog.md`
34
- - `foundation/feature-inventory.md`
35
-
36
- **Operations:**
37
- - `operations/ci-cd.md`
38
- - `operations/production-runbook.md`
39
- - `operations/governance.md`
40
- - `operations/compliance.md`
41
- - `operations/observability.md`
42
- - `operations/security.md`
43
-
44
- **Technical:**
45
- - `technical/testing.md`
46
- - `technical/api-contract.md`
47
- - `technical/database.md`
48
- - `technical/ui-ux.md`
49
- - `technical/error-handling.md`
50
- - `technical/internationalization.md`
51
-
52
- ## Final Pass
53
- Before finishing, check that:
54
- 1. No files are generated in the root of `project-docs/` except `index.md` and `getting-started.md`. Everything else must be in its respective subfolder.
55
- 2. `foundation/architecture.md` and `technical/testing.md` do not conflict.
56
- 3. The generated documents strictly follow the Flexible Baselines principle (you may omit heavily specialized docs if the user confirms they aren't needed).
57
-
58
- ## Inputs
59
- Use the project brief, codebase, and constraints provided below to begin generation.