@adityaaria/agent-os 1.0.0
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/AGENTS.md +41 -0
- package/AGENT_OS_BOOTSTRAP.md +29 -0
- package/ENTRYPOINT.md +118 -0
- package/LICENSE +21 -0
- package/README.md +230 -0
- package/adapters/antigravity/README.md +9 -0
- package/adapters/antigravity/plugin.json +13 -0
- package/adapters/claude/CLAUDE.md +16 -0
- package/adapters/claude/README.md +10 -0
- package/adapters/codex/README.md +20 -0
- package/adapters/cursor/README.md +9 -0
- package/adapters/cursor/agent-os.rules.md +18 -0
- package/bin/agent-os.mjs +98 -0
- package/core/AUTO_PROJECT_DETECTOR.md +99 -0
- package/core/COMPLIANCE_GATE.md +19 -0
- package/core/FRAMEWORK_AUDITOR.md +35 -0
- package/core/KNOWLEDGE_REGENERATOR.md +30 -0
- package/core/KNOWLEDGE_VALIDATOR.md +29 -0
- package/core/PROJECT_CONTEXT_STANDARD.md +19 -0
- package/core/QUALITY_GATES.md +42 -0
- package/core/REPORTING_STANDARD.md +47 -0
- package/core/SKILL_ORCHESTRATOR.md +63 -0
- package/core/TASK_ROUTER.md +33 -0
- package/core/TRACEABILITY_STANDARD.md +40 -0
- package/package.json +28 -0
- package/scripts/install.mjs +690 -0
- package/scripts/lib/cli-utils.mjs +148 -0
- package/scripts/lib/run-utils.mjs +185 -0
- package/scripts/lib/telegram-audit-log.mjs +50 -0
- package/scripts/lib/telegram-bot-utils.mjs +413 -0
- package/scripts/lib/telegram-utils.mjs +127 -0
- package/scripts/orchestrate.mjs +230 -0
- package/scripts/quality-static.mjs +19 -0
- package/scripts/report-export.mjs +86 -0
- package/scripts/report-notify.mjs +169 -0
- package/scripts/run-execution.mjs +83 -0
- package/scripts/run-list.mjs +44 -0
- package/scripts/run-status.mjs +38 -0
- package/scripts/run-step.mjs +173 -0
- package/scripts/setup-wizard.mjs +116 -0
- package/scripts/sync-runtime.mjs +87 -0
- package/scripts/telegram-bot.mjs +88 -0
- package/scripts/telegram-check.mjs +94 -0
- package/scripts/telegram-poll.mjs +176 -0
- package/scripts/validate-framework.mjs +290 -0
- package/skills/api-contract-audit/SKILL.md +26 -0
- package/skills/api-contract-audit/checklist.md +16 -0
- package/skills/api-contract-audit/examples.md +3 -0
- package/skills/api-contract-audit/report-template.md +39 -0
- package/skills/api-contract-audit/workflow.md +15 -0
- package/skills/audit/SKILL.md +28 -0
- package/skills/audit/checklist.md +18 -0
- package/skills/audit/examples.md +26 -0
- package/skills/audit/report-template.md +39 -0
- package/skills/audit/workflow.md +15 -0
- package/skills/bug-fix/SKILL.md +25 -0
- package/skills/bug-fix/checklist.md +18 -0
- package/skills/bug-fix/examples.md +26 -0
- package/skills/bug-fix/report-template.md +39 -0
- package/skills/bug-fix/workflow.md +10 -0
- package/skills/database-impact-analysis/SKILL.md +27 -0
- package/skills/database-impact-analysis/checklist.md +16 -0
- package/skills/database-impact-analysis/examples.md +3 -0
- package/skills/database-impact-analysis/report-template.md +39 -0
- package/skills/database-impact-analysis/workflow.md +14 -0
- package/skills/enhancement/SKILL.md +27 -0
- package/skills/enhancement/checklist.md +19 -0
- package/skills/enhancement/examples.md +26 -0
- package/skills/enhancement/report-template.md +39 -0
- package/skills/enhancement/workflow.md +10 -0
- package/skills/enterprise-certification/SKILL.md +19 -0
- package/skills/enterprise-certification/checklist.md +17 -0
- package/skills/enterprise-certification/report-template.md +39 -0
- package/skills/enterprise-certification/workflow.md +14 -0
- package/skills/knowledge-evolution/SKILL.md +23 -0
- package/skills/knowledge-evolution/checklist.md +17 -0
- package/skills/knowledge-evolution/report-template.md +39 -0
- package/skills/knowledge-evolution/workflow.md +14 -0
- package/skills/new-page/SKILL.md +26 -0
- package/skills/new-page/checklist.md +21 -0
- package/skills/new-page/examples.md +26 -0
- package/skills/new-page/report-template.md +39 -0
- package/skills/new-page/workflow.md +10 -0
- package/skills/project-onboarding/SKILL.md +27 -0
- package/skills/project-onboarding/checklist.md +18 -0
- package/skills/project-onboarding/examples.md +26 -0
- package/skills/project-onboarding/report-template.md +39 -0
- package/skills/project-onboarding/workflow.md +9 -0
- package/skills/release-readiness/SKILL.md +27 -0
- package/skills/release-readiness/checklist.md +16 -0
- package/skills/release-readiness/examples.md +3 -0
- package/skills/release-readiness/report-template.md +39 -0
- package/skills/release-readiness/workflow.md +14 -0
- package/skills/repository-health/SKILL.md +26 -0
- package/skills/repository-health/checklist.md +20 -0
- package/skills/repository-health/report-template.md +39 -0
- package/skills/repository-health/workflow.md +14 -0
- package/skills/selenium-e2e/SKILL.md +83 -0
- package/skills/selenium-e2e/checklist.md +29 -0
- package/skills/selenium-e2e/examples.md +26 -0
- package/skills/selenium-e2e/report-template.md +39 -0
- package/skills/selenium-e2e/workflow.md +9 -0
- package/skills/self-audit/SKILL.md +19 -0
- package/skills/self-audit/checklist.md +14 -0
- package/skills/self-audit/report-template.md +39 -0
- package/skills/self-audit/workflow.md +11 -0
- package/skills/traceability-analysis/SKILL.md +25 -0
- package/skills/traceability-analysis/checklist.md +17 -0
- package/skills/traceability-analysis/examples.md +3 -0
- package/skills/traceability-analysis/report-template.md +39 -0
- package/skills/traceability-analysis/workflow.md +17 -0
- package/templates/API_RULES.md +20 -0
- package/templates/ARCHITECTURE.md +20 -0
- package/templates/BUSINESS_FLOW.md +20 -0
- package/templates/COMMANDS.md +20 -0
- package/templates/DATABASE_RULES.md +20 -0
- package/templates/DEPENDENCY_MAP.md +20 -0
- package/templates/DEPLOYMENT_RULES.md +20 -0
- package/templates/DOMAIN_MODEL.md +20 -0
- package/templates/FE_BE_TRACEABILITY.md +20 -0
- package/templates/KNOWN_LIMITATIONS.md +20 -0
- package/templates/MODULE_CATALOG.md +20 -0
- package/templates/PROJECT_PROFILE.md +20 -0
- package/templates/RISK_REGISTER.md +20 -0
- package/templates/SECURITY_RULES.md +20 -0
- package/templates/TECHNICAL_DEBT.md +20 -0
- package/templates/TECH_STACK.md +20 -0
- package/templates/TESTING_RULES.md +47 -0
- package/templates/UI_UX_RULES.md +20 -0
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
# TRACEABILITY-ANALYSIS SKILL
|
|
2
|
+
|
|
3
|
+
## Purpose
|
|
4
|
+
To serve as the foundational tracking and mapping skill for Agent OS. This skill autonomously establishes strict connections between business requirements and the database layer.
|
|
5
|
+
|
|
6
|
+
## Responsibilities
|
|
7
|
+
- Parse project source code to map the entire execution path.
|
|
8
|
+
- Detect broken links in the stack.
|
|
9
|
+
- Serve as a prerequisite for `bug-fix`, `enhancement`, `new-page`, and `audit` skills.
|
|
10
|
+
|
|
11
|
+
## Workflow
|
|
12
|
+
Follow the detailed workflow in `workflow.md` for this skill.
|
|
13
|
+
|
|
14
|
+
## Required Inputs
|
|
15
|
+
Minimal Prompting: E.g., `TRACE: Halaman Request Leave` or automatically triggered by other skills.
|
|
16
|
+
|
|
17
|
+
## Expected Outputs
|
|
18
|
+
A comprehensive Traceability Matrix mapped from UI down to the Database.
|
|
19
|
+
|
|
20
|
+
## Execution Rules
|
|
21
|
+
- **Autonomy**: You MUST autonomously infer context from project knowledge generated during onboarding. Do not ask the user for basic structural information.
|
|
22
|
+
- **Evidence Collection**: Gather Logs, Network Traces, or SQL Results if applicable to prove the trace exists.
|
|
23
|
+
|
|
24
|
+
## Minimal Prompting Target
|
|
25
|
+
- If the user types `BUG: Submit Error`, immediately trigger this skill to trace the "Submit" action down to the DB layer before attempting a fix.
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# TRACEABILITY-ANALYSIS CHECKLIST
|
|
2
|
+
|
|
3
|
+
Before concluding the task, ensure all items are complete:
|
|
4
|
+
|
|
5
|
+
## Entry Criteria
|
|
6
|
+
- [ ] Target module or requirement is clearly identified.
|
|
7
|
+
|
|
8
|
+
## Execution
|
|
9
|
+
- [ ] Mapped UI components and routes.
|
|
10
|
+
- [ ] Mapped API payloads and endpoints.
|
|
11
|
+
- [ ] Mapped Backend logic and controllers.
|
|
12
|
+
- [ ] Mapped Database entities and tables.
|
|
13
|
+
|
|
14
|
+
## Exit Criteria / Definition of Done
|
|
15
|
+
- [ ] Traceability Matrix is complete and unbroken.
|
|
16
|
+
- [ ] Missing links (Technical Debt) are explicitly flagged.
|
|
17
|
+
- [ ] Quality Gate is set to PASS.
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
# Executive Summary
|
|
2
|
+
* **Trigger Detected**: N/A. Reason: Populated during skill execution.
|
|
3
|
+
* **Purpose**: N/A. Reason: Populated during skill execution.
|
|
4
|
+
|
|
5
|
+
# Scope
|
|
6
|
+
* **Target**: N/A. Reason: Populated during skill execution.
|
|
7
|
+
|
|
8
|
+
# Knowledge Confidence
|
|
9
|
+
* **Score**: N/A. Reason: Populated during skill execution.
|
|
10
|
+
|
|
11
|
+
# Knowledge Classification
|
|
12
|
+
* **Classification**: N/A. Reason: Populated during skill execution.
|
|
13
|
+
|
|
14
|
+
# Traceability Matrix
|
|
15
|
+
| Layer | File | Function | Notes |
|
|
16
|
+
| ----- | ---- | -------- | ----- |
|
|
17
|
+
| Framework | N/A. Reason: Populated during skill execution. | N/A. Reason: Populated during skill execution. | N/A. Reason: Populated during skill execution. |
|
|
18
|
+
|
|
19
|
+
# Evidence
|
|
20
|
+
* N/A. Reason: Populated during skill execution.
|
|
21
|
+
|
|
22
|
+
# Root Cause
|
|
23
|
+
* N/A. Reason: Populated during skill execution.
|
|
24
|
+
|
|
25
|
+
# Impact
|
|
26
|
+
* N/A. Reason: Populated during skill execution.
|
|
27
|
+
|
|
28
|
+
# Recommendation
|
|
29
|
+
* **Quick Win**: N/A. Reason: Populated during skill execution.
|
|
30
|
+
* **Long Term Improvement**: N/A. Reason: Populated during skill execution.
|
|
31
|
+
|
|
32
|
+
# Quality Gate
|
|
33
|
+
* N/A. Reason: Populated during skill execution.
|
|
34
|
+
|
|
35
|
+
# Enterprise Readiness
|
|
36
|
+
* N/A. Reason: Populated during skill execution.
|
|
37
|
+
|
|
38
|
+
# Final Decision
|
|
39
|
+
N/A. Reason: Populated during skill execution.
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# TRACEABILITY-ANALYSIS WORKFLOW
|
|
2
|
+
|
|
3
|
+
You MUST execute these explicit steps sequentially:
|
|
4
|
+
|
|
5
|
+
1. **Pre Validation** (Verify `project-onboarding` knowledge exists)
|
|
6
|
+
2. **Requirement Analysis** (Identify business context)
|
|
7
|
+
3. **Route & Page Detection** (Locate frontend entrypoints)
|
|
8
|
+
4. **Component & State Mapping** (Locate form/composable/store)
|
|
9
|
+
5. **FE Service Mapping** (Locate API client)
|
|
10
|
+
6. **API Contract Matching** (Match FE request to BE Swagger/DTO)
|
|
11
|
+
7. **BE Controller Mapping** (Locate entrypoint)
|
|
12
|
+
8. **BE Service Mapping** (Locate business logic)
|
|
13
|
+
9. **Repository & Entity Mapping** (Locate ORM and DAO)
|
|
14
|
+
10. **Database Schema Mapping** (Identify actual tables/columns)
|
|
15
|
+
11. **Execution Validation** (Calculate Coverage % and explicitly flag ASSUMED links)
|
|
16
|
+
12. **Generate Traceability Matrix**
|
|
17
|
+
13. **Post Validation** (Verify report conforms to Enterprise Standard)
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# API_RULES
|
|
2
|
+
|
|
3
|
+
## Purpose
|
|
4
|
+
To explicitly document the actual implementation details of API RULES for the project.
|
|
5
|
+
|
|
6
|
+
## Responsibilities
|
|
7
|
+
- Provide deterministic context for coding agents.
|
|
8
|
+
- Eliminate guessing or hallucination.
|
|
9
|
+
|
|
10
|
+
## Workflow
|
|
11
|
+
1. Agent parses user prompt.
|
|
12
|
+
2. Agent reads this file if relevant to the task.
|
|
13
|
+
3. Agent adheres strictly to these documented patterns.
|
|
14
|
+
|
|
15
|
+
## Examples
|
|
16
|
+
This file is a template and will be generated based on the actual project.
|
|
17
|
+
|
|
18
|
+
## Notes
|
|
19
|
+
> [!NOTE]
|
|
20
|
+
> If this layer does not exist in the project, state "N/A".
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# ARCHITECTURE
|
|
2
|
+
|
|
3
|
+
## Purpose
|
|
4
|
+
To explicitly document the actual implementation details of ARCHITECTURE for the project.
|
|
5
|
+
|
|
6
|
+
## Responsibilities
|
|
7
|
+
- Provide deterministic context for coding agents.
|
|
8
|
+
- Eliminate guessing or hallucination.
|
|
9
|
+
|
|
10
|
+
## Workflow
|
|
11
|
+
1. Agent parses user prompt.
|
|
12
|
+
2. Agent reads this file if relevant to the task.
|
|
13
|
+
3. Agent adheres strictly to these documented patterns.
|
|
14
|
+
|
|
15
|
+
## Examples
|
|
16
|
+
This file is a template and will be generated based on the actual project.
|
|
17
|
+
|
|
18
|
+
## Notes
|
|
19
|
+
> [!NOTE]
|
|
20
|
+
> If this layer does not exist in the project, state "N/A".
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# BUSINESS_FLOW
|
|
2
|
+
|
|
3
|
+
## Purpose
|
|
4
|
+
To explicitly document the actual implementation details of BUSINESS FLOW for the project.
|
|
5
|
+
|
|
6
|
+
## Responsibilities
|
|
7
|
+
- Provide deterministic context for coding agents.
|
|
8
|
+
- Eliminate guessing or hallucination.
|
|
9
|
+
|
|
10
|
+
## Workflow
|
|
11
|
+
1. Agent parses user prompt.
|
|
12
|
+
2. Agent reads this file if relevant to the task.
|
|
13
|
+
3. Agent adheres strictly to these documented patterns.
|
|
14
|
+
|
|
15
|
+
## Examples
|
|
16
|
+
This file is a template and will be generated based on the actual project.
|
|
17
|
+
|
|
18
|
+
## Notes
|
|
19
|
+
> [!NOTE]
|
|
20
|
+
> If this layer does not exist in the project, state "N/A".
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# COMMANDS
|
|
2
|
+
|
|
3
|
+
## Purpose
|
|
4
|
+
To explicitly document the actual implementation details of COMMANDS for the project.
|
|
5
|
+
|
|
6
|
+
## Responsibilities
|
|
7
|
+
- Provide deterministic context for coding agents.
|
|
8
|
+
- Eliminate guessing or hallucination.
|
|
9
|
+
|
|
10
|
+
## Workflow
|
|
11
|
+
1. Agent parses user prompt.
|
|
12
|
+
2. Agent reads this file if relevant to the task.
|
|
13
|
+
3. Agent adheres strictly to these documented patterns.
|
|
14
|
+
|
|
15
|
+
## Examples
|
|
16
|
+
This file is a template and will be generated based on the actual project.
|
|
17
|
+
|
|
18
|
+
## Notes
|
|
19
|
+
> [!NOTE]
|
|
20
|
+
> If this layer does not exist in the project, state "N/A".
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# DATABASE_RULES
|
|
2
|
+
|
|
3
|
+
## Purpose
|
|
4
|
+
To explicitly document the actual implementation details of DATABASE RULES for the project.
|
|
5
|
+
|
|
6
|
+
## Responsibilities
|
|
7
|
+
- Provide deterministic context for coding agents.
|
|
8
|
+
- Eliminate guessing or hallucination.
|
|
9
|
+
|
|
10
|
+
## Workflow
|
|
11
|
+
1. Agent parses user prompt.
|
|
12
|
+
2. Agent reads this file if relevant to the task.
|
|
13
|
+
3. Agent adheres strictly to these documented patterns.
|
|
14
|
+
|
|
15
|
+
## Examples
|
|
16
|
+
This file is a template and will be generated based on the actual project.
|
|
17
|
+
|
|
18
|
+
## Notes
|
|
19
|
+
> [!NOTE]
|
|
20
|
+
> If this layer does not exist in the project, state "N/A".
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# DEPENDENCY_MAP
|
|
2
|
+
|
|
3
|
+
## Purpose
|
|
4
|
+
To explicitly document the actual implementation details of DEPENDENCY MAP for the project.
|
|
5
|
+
|
|
6
|
+
## Responsibilities
|
|
7
|
+
- Provide deterministic context for coding agents.
|
|
8
|
+
- Eliminate guessing or hallucination.
|
|
9
|
+
|
|
10
|
+
## Workflow
|
|
11
|
+
1. Agent parses user prompt.
|
|
12
|
+
2. Agent reads this file if relevant to the task.
|
|
13
|
+
3. Agent adheres strictly to these documented patterns.
|
|
14
|
+
|
|
15
|
+
## Examples
|
|
16
|
+
This file is a template and will be generated based on the actual project.
|
|
17
|
+
|
|
18
|
+
## Notes
|
|
19
|
+
> [!NOTE]
|
|
20
|
+
> If this layer does not exist in the project, state "N/A".
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# DEPLOYMENT_RULES
|
|
2
|
+
|
|
3
|
+
## Purpose
|
|
4
|
+
To explicitly document the actual implementation details of DEPLOYMENT RULES for the project.
|
|
5
|
+
|
|
6
|
+
## Responsibilities
|
|
7
|
+
- Provide deterministic context for coding agents.
|
|
8
|
+
- Eliminate guessing or hallucination.
|
|
9
|
+
|
|
10
|
+
## Workflow
|
|
11
|
+
1. Agent parses user prompt.
|
|
12
|
+
2. Agent reads this file if relevant to the task.
|
|
13
|
+
3. Agent adheres strictly to these documented patterns.
|
|
14
|
+
|
|
15
|
+
## Examples
|
|
16
|
+
This file is a template and will be generated based on the actual project.
|
|
17
|
+
|
|
18
|
+
## Notes
|
|
19
|
+
> [!NOTE]
|
|
20
|
+
> If this layer does not exist in the project, state "N/A".
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# DOMAIN_MODEL
|
|
2
|
+
|
|
3
|
+
## Purpose
|
|
4
|
+
To explicitly document the actual implementation details of DOMAIN MODEL for the project.
|
|
5
|
+
|
|
6
|
+
## Responsibilities
|
|
7
|
+
- Provide deterministic context for coding agents.
|
|
8
|
+
- Eliminate guessing or hallucination.
|
|
9
|
+
|
|
10
|
+
## Workflow
|
|
11
|
+
1. Agent parses user prompt.
|
|
12
|
+
2. Agent reads this file if relevant to the task.
|
|
13
|
+
3. Agent adheres strictly to these documented patterns.
|
|
14
|
+
|
|
15
|
+
## Examples
|
|
16
|
+
This file is a template and will be generated based on the actual project.
|
|
17
|
+
|
|
18
|
+
## Notes
|
|
19
|
+
> [!NOTE]
|
|
20
|
+
> If this layer does not exist in the project, state "N/A".
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# FE_BE_TRACEABILITY
|
|
2
|
+
|
|
3
|
+
## Purpose
|
|
4
|
+
To explicitly document the actual implementation details of FE BE TRACEABILITY for the project.
|
|
5
|
+
|
|
6
|
+
## Responsibilities
|
|
7
|
+
- Provide deterministic context for coding agents.
|
|
8
|
+
- Eliminate guessing or hallucination.
|
|
9
|
+
|
|
10
|
+
## Workflow
|
|
11
|
+
1. Agent parses user prompt.
|
|
12
|
+
2. Agent reads this file if relevant to the task.
|
|
13
|
+
3. Agent adheres strictly to these documented patterns.
|
|
14
|
+
|
|
15
|
+
## Examples
|
|
16
|
+
This file is a template and will be generated based on the actual project.
|
|
17
|
+
|
|
18
|
+
## Notes
|
|
19
|
+
> [!NOTE]
|
|
20
|
+
> If this layer does not exist in the project, state "N/A".
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# KNOWN_LIMITATIONS
|
|
2
|
+
|
|
3
|
+
## Purpose
|
|
4
|
+
To explicitly document the actual implementation details of KNOWN LIMITATIONS for the project.
|
|
5
|
+
|
|
6
|
+
## Responsibilities
|
|
7
|
+
- Provide deterministic context for coding agents.
|
|
8
|
+
- Eliminate guessing or hallucination.
|
|
9
|
+
|
|
10
|
+
## Workflow
|
|
11
|
+
1. Agent parses user prompt.
|
|
12
|
+
2. Agent reads this file if relevant to the task.
|
|
13
|
+
3. Agent adheres strictly to these documented patterns.
|
|
14
|
+
|
|
15
|
+
## Examples
|
|
16
|
+
This file is a template and will be generated based on the actual project.
|
|
17
|
+
|
|
18
|
+
## Notes
|
|
19
|
+
> [!NOTE]
|
|
20
|
+
> If this layer does not exist in the project, state "N/A".
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# MODULE_CATALOG
|
|
2
|
+
|
|
3
|
+
## Purpose
|
|
4
|
+
To explicitly document the actual implementation details of MODULE CATALOG for the project.
|
|
5
|
+
|
|
6
|
+
## Responsibilities
|
|
7
|
+
- Provide deterministic context for coding agents.
|
|
8
|
+
- Eliminate guessing or hallucination.
|
|
9
|
+
|
|
10
|
+
## Workflow
|
|
11
|
+
1. Agent parses user prompt.
|
|
12
|
+
2. Agent reads this file if relevant to the task.
|
|
13
|
+
3. Agent adheres strictly to these documented patterns.
|
|
14
|
+
|
|
15
|
+
## Examples
|
|
16
|
+
This file is a template and will be generated based on the actual project.
|
|
17
|
+
|
|
18
|
+
## Notes
|
|
19
|
+
> [!NOTE]
|
|
20
|
+
> If this layer does not exist in the project, state "N/A".
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# PROJECT_PROFILE
|
|
2
|
+
|
|
3
|
+
## Purpose
|
|
4
|
+
To explicitly document the actual implementation details of PROJECT PROFILE for the project.
|
|
5
|
+
|
|
6
|
+
## Responsibilities
|
|
7
|
+
- Provide deterministic context for coding agents.
|
|
8
|
+
- Eliminate guessing or hallucination.
|
|
9
|
+
|
|
10
|
+
## Workflow
|
|
11
|
+
1. Agent parses user prompt.
|
|
12
|
+
2. Agent reads this file if relevant to the task.
|
|
13
|
+
3. Agent adheres strictly to these documented patterns.
|
|
14
|
+
|
|
15
|
+
## Examples
|
|
16
|
+
This file is a template and will be generated based on the actual project.
|
|
17
|
+
|
|
18
|
+
## Notes
|
|
19
|
+
> [!NOTE]
|
|
20
|
+
> If this layer does not exist in the project, state "N/A".
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# RISK_REGISTER
|
|
2
|
+
|
|
3
|
+
## Purpose
|
|
4
|
+
To explicitly document the actual implementation details of RISK REGISTER for the project.
|
|
5
|
+
|
|
6
|
+
## Responsibilities
|
|
7
|
+
- Provide deterministic context for coding agents.
|
|
8
|
+
- Eliminate guessing or hallucination.
|
|
9
|
+
|
|
10
|
+
## Workflow
|
|
11
|
+
1. Agent parses user prompt.
|
|
12
|
+
2. Agent reads this file if relevant to the task.
|
|
13
|
+
3. Agent adheres strictly to these documented patterns.
|
|
14
|
+
|
|
15
|
+
## Examples
|
|
16
|
+
This file is a template and will be generated based on the actual project.
|
|
17
|
+
|
|
18
|
+
## Notes
|
|
19
|
+
> [!NOTE]
|
|
20
|
+
> If this layer does not exist in the project, state "N/A".
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# SECURITY_RULES
|
|
2
|
+
|
|
3
|
+
## Purpose
|
|
4
|
+
To explicitly document the actual implementation details of SECURITY RULES for the project.
|
|
5
|
+
|
|
6
|
+
## Responsibilities
|
|
7
|
+
- Provide deterministic context for coding agents.
|
|
8
|
+
- Eliminate guessing or hallucination.
|
|
9
|
+
|
|
10
|
+
## Workflow
|
|
11
|
+
1. Agent parses user prompt.
|
|
12
|
+
2. Agent reads this file if relevant to the task.
|
|
13
|
+
3. Agent adheres strictly to these documented patterns.
|
|
14
|
+
|
|
15
|
+
## Examples
|
|
16
|
+
This file is a template and will be generated based on the actual project.
|
|
17
|
+
|
|
18
|
+
## Notes
|
|
19
|
+
> [!NOTE]
|
|
20
|
+
> If this layer does not exist in the project, state "N/A".
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# TECHNICAL_DEBT
|
|
2
|
+
|
|
3
|
+
## Purpose
|
|
4
|
+
To explicitly document the actual implementation details of TECHNICAL DEBT for the project.
|
|
5
|
+
|
|
6
|
+
## Responsibilities
|
|
7
|
+
- Provide deterministic context for coding agents.
|
|
8
|
+
- Eliminate guessing or hallucination.
|
|
9
|
+
|
|
10
|
+
## Workflow
|
|
11
|
+
1. Agent parses user prompt.
|
|
12
|
+
2. Agent reads this file if relevant to the task.
|
|
13
|
+
3. Agent adheres strictly to these documented patterns.
|
|
14
|
+
|
|
15
|
+
## Examples
|
|
16
|
+
This file is a template and will be generated based on the actual project.
|
|
17
|
+
|
|
18
|
+
## Notes
|
|
19
|
+
> [!NOTE]
|
|
20
|
+
> If this layer does not exist in the project, state "N/A".
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# TECH_STACK
|
|
2
|
+
|
|
3
|
+
## Purpose
|
|
4
|
+
To explicitly document the actual implementation details of TECH STACK for the project.
|
|
5
|
+
|
|
6
|
+
## Responsibilities
|
|
7
|
+
- Provide deterministic context for coding agents.
|
|
8
|
+
- Eliminate guessing or hallucination.
|
|
9
|
+
|
|
10
|
+
## Workflow
|
|
11
|
+
1. Agent parses user prompt.
|
|
12
|
+
2. Agent reads this file if relevant to the task.
|
|
13
|
+
3. Agent adheres strictly to these documented patterns.
|
|
14
|
+
|
|
15
|
+
## Examples
|
|
16
|
+
This file is a template and will be generated based on the actual project.
|
|
17
|
+
|
|
18
|
+
## Notes
|
|
19
|
+
> [!NOTE]
|
|
20
|
+
> If this layer does not exist in the project, state "N/A".
|
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
# TESTING_RULES
|
|
2
|
+
|
|
3
|
+
## Purpose
|
|
4
|
+
To explicitly document the actual implementation details of TESTING RULES for the project, enforcing enterprise standards for Test Scenario Generation, Environment Readiness, and Code Quality in Automation.
|
|
5
|
+
|
|
6
|
+
## Responsibilities
|
|
7
|
+
- Provide deterministic context for coding agents writing tests.
|
|
8
|
+
- Eliminate guessing or hallucination of selectors, mock data, and test environments.
|
|
9
|
+
- Enforce strict traceability between Frontend actions and Backend impacts.
|
|
10
|
+
|
|
11
|
+
## Workflow
|
|
12
|
+
1. Agent parses user prompt.
|
|
13
|
+
2. Agent reads this file if relevant to the task (e.g., executing the `selenium-e2e` skill).
|
|
14
|
+
3. Agent adheres strictly to these documented patterns.
|
|
15
|
+
|
|
16
|
+
## 1. Environment Readiness (E2E & Integration)
|
|
17
|
+
Agents MUST verify that the testing environment is ready before scripting:
|
|
18
|
+
- Check for test runners/dependencies (e.g., `jest`, `cypress`, `selenium-webdriver`).
|
|
19
|
+
- Identify target execution environments (Local browsers, CI/CD pipelines).
|
|
20
|
+
- Verify standard test directory structures (`tests/`, `e2e/`, `__tests__/`).
|
|
21
|
+
|
|
22
|
+
## 2. Test Scenario Standards
|
|
23
|
+
Tests must be comprehensive. When prompted to test a feature, agents MUST generate:
|
|
24
|
+
1. **Happy Path**: Core business logic executes flawlessly.
|
|
25
|
+
2. **Validation**: Form inputs, required fields, type matching.
|
|
26
|
+
3. **Negative Testing**: Handling API errors, unauthorized access, and simulated network failures.
|
|
27
|
+
4. **Edge Cases**: Empty datasets, maximum length boundaries, pagination limits.
|
|
28
|
+
|
|
29
|
+
## 3. UI Selector Standards (Strict)
|
|
30
|
+
When writing UI automation (Selenium, Cypress, Playwright):
|
|
31
|
+
- **PRIORITY 1**: `data-testid` (Mandatory if possible).
|
|
32
|
+
- **PRIORITY 2**: `id` or `name` (If unique).
|
|
33
|
+
- **PRIORITY 3**: `aria-label` (For accessibility compliance).
|
|
34
|
+
- **FORBIDDEN**: Long XPath chains, brittle CSS descendant selectors (`div > ul > li:nth-child(3)`).
|
|
35
|
+
|
|
36
|
+
## 4. Wait Strategy Standards (Strict)
|
|
37
|
+
When dealing with asynchronous rendering or API calls:
|
|
38
|
+
- **FORBIDDEN**: Hardcoded sleeps (e.g., `sleep(5000)` or `setTimeout`).
|
|
39
|
+
- **MANDATORY**: Explicit Waits (e.g., wait until element is visible, clickable, or a specific API request completes).
|
|
40
|
+
|
|
41
|
+
## 5. Traceability
|
|
42
|
+
Agents MUST trace UI actions back to their Backend implementation. Documentation and Test Reports must demonstrate the flow:
|
|
43
|
+
`UI Interaction -> FE Component -> API Endpoint -> Backend Controller -> Entity/Database`.
|
|
44
|
+
|
|
45
|
+
## Notes
|
|
46
|
+
> [!NOTE]
|
|
47
|
+
> If a component lacks `data-testid` attributes or is difficult to test, agents must report this as Technical Debt rather than writing a brittle test around it.
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# UI_UX_RULES
|
|
2
|
+
|
|
3
|
+
## Purpose
|
|
4
|
+
To explicitly document the actual implementation details of UI UX RULES for the project.
|
|
5
|
+
|
|
6
|
+
## Responsibilities
|
|
7
|
+
- Provide deterministic context for coding agents.
|
|
8
|
+
- Eliminate guessing or hallucination.
|
|
9
|
+
|
|
10
|
+
## Workflow
|
|
11
|
+
1. Agent parses user prompt.
|
|
12
|
+
2. Agent reads this file if relevant to the task.
|
|
13
|
+
3. Agent adheres strictly to these documented patterns.
|
|
14
|
+
|
|
15
|
+
## Examples
|
|
16
|
+
This file is a template and will be generated based on the actual project.
|
|
17
|
+
|
|
18
|
+
## Notes
|
|
19
|
+
> [!NOTE]
|
|
20
|
+
> If this layer does not exist in the project, state "N/A".
|