knowzcode 0.4.0 → 0.5.2
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/.claude-plugin/marketplace.json +61 -61
- package/.claude-plugin/plugin.json +8 -8
- package/LICENSE +121 -121
- package/README.md +379 -354
- package/agents/analyst.md +114 -114
- package/agents/architect.md +200 -200
- package/agents/builder.md +104 -104
- package/agents/closer.md +177 -177
- package/agents/context-scout.md +54 -54
- package/agents/knowledge-migrator.md +349 -349
- package/agents/knowz-scout.md +83 -83
- package/agents/knowz-scribe.md +180 -180
- package/agents/microfix-specialist.md +135 -135
- package/agents/project-advisor.md +111 -111
- package/agents/reviewer.md +172 -172
- package/agents/security-officer.md +194 -194
- package/agents/test-advisor.md +162 -162
- package/agents/update-coordinator.md +394 -394
- package/bin/knowzcode.mjs +1457 -1199
- package/commands/audit.md +328 -328
- package/commands/connect-mcp.md +574 -549
- package/commands/fix.md +107 -107
- package/commands/init.md +616 -500
- package/commands/learn.md +332 -332
- package/commands/plan.md +272 -272
- package/commands/register.md +757 -733
- package/commands/status.md +338 -309
- package/commands/telemetry-setup.md +368 -368
- package/commands/telemetry.md +188 -188
- package/commands/work.md +1204 -1204
- package/knowzcode/automation_manifest.md +59 -59
- package/knowzcode/claude_code_execution.md +431 -431
- package/knowzcode/copilot_execution.md +231 -231
- package/knowzcode/enterprise/compliance_manifest.md +137 -137
- package/knowzcode/enterprise/compliance_status.md +30 -30
- package/knowzcode/enterprise/guidelines/code-quality.md +67 -67
- package/knowzcode/enterprise/guidelines/security.md +355 -355
- package/knowzcode/enterprise/templates/guideline-template.md +55 -55
- package/knowzcode/gitignore.template +13 -13
- package/knowzcode/knowzcode_architecture.md +51 -51
- package/knowzcode/knowzcode_log.md +142 -142
- package/knowzcode/knowzcode_loop.md +601 -596
- package/knowzcode/knowzcode_orchestration.md +66 -66
- package/knowzcode/knowzcode_project.md +48 -48
- package/knowzcode/knowzcode_tracker.md +40 -40
- package/knowzcode/knowzcode_vaults.md +257 -257
- package/knowzcode/mcp_config.md +196 -191
- package/knowzcode/planning/Readme.md +6 -6
- package/knowzcode/platform_adapters.md +2577 -1260
- package/knowzcode/prompts/Execute_Micro_Fix.md +57 -57
- package/knowzcode/prompts/Investigate_Codebase.md +227 -227
- package/knowzcode/prompts/Migrate_Knowledge.md +301 -301
- package/knowzcode/prompts/Refactor_Node.md +72 -72
- package/knowzcode/prompts/Spec_Verification_Checkpoint.md +59 -59
- package/knowzcode/prompts/[LOOP_1A]__Propose_Change_Set.md +52 -52
- package/knowzcode/prompts/[LOOP_1B]__Draft_Specs.md +75 -75
- package/knowzcode/prompts/[LOOP_2A]__Implement_Change_Set.md +55 -55
- package/knowzcode/prompts/[LOOP_2B]__Verify_Implementation.md +72 -72
- package/knowzcode/prompts/[LOOP_3]__Finalize_And_Commit.md +67 -67
- package/knowzcode/specs/Readme.md +10 -10
- package/knowzcode/telemetry_config.md +89 -89
- package/knowzcode/user_preferences.md +120 -120
- package/package.json +53 -53
- package/skills/alias-resolver.json +15 -15
- package/skills/architecture-diff.json +12 -12
- package/skills/check-installation-status.json +14 -14
- package/skills/continue.md +126 -126
- package/skills/environment-guard.json +12 -12
- package/skills/generate-workgroup-id.json +25 -25
- package/skills/install-knowzcode.json +21 -21
- package/skills/load-core-context.json +18 -18
- package/skills/log-entry-builder.json +15 -15
- package/skills/spec-quality-check.json +14 -14
- package/skills/spec-template.json +15 -15
- package/skills/spec-validator.json +25 -25
- package/skills/start-work.md +224 -224
- package/skills/tracker-scan.json +12 -12
- package/skills/tracker-update.json +28 -28
- package/skills/validate-installation.json +14 -14
|
@@ -1,137 +1,137 @@
|
|
|
1
|
-
# Enterprise Compliance Manifest
|
|
2
|
-
|
|
3
|
-
> **Status: Experimental** — This feature is partially implemented. Security guidelines are functional; code-quality guidelines are templates only. No automated tests exist yet. Use at your own discretion.
|
|
4
|
-
|
|
5
|
-
**Purpose:** Defines which enterprise guidelines are active and their enforcement level.
|
|
6
|
-
|
|
7
|
-
---
|
|
8
|
-
|
|
9
|
-
## Active Guidelines
|
|
10
|
-
|
|
11
|
-
| Guideline File | Enforcement | Applies To | Active |
|
|
12
|
-
|:---------------|:------------|:-----------|:-------|
|
|
13
|
-
| security.md | blocking | both | false |
|
|
14
|
-
| code-quality.md | advisory | implementation | false |
|
|
15
|
-
|
|
16
|
-
> **Note:** Set `Active` to `true` to enable a guideline. Guidelines with empty content are skipped.
|
|
17
|
-
|
|
18
|
-
---
|
|
19
|
-
|
|
20
|
-
## Enforcement Levels
|
|
21
|
-
|
|
22
|
-
| Level | Behavior |
|
|
23
|
-
|:------|:---------|
|
|
24
|
-
| **blocking** | Violations STOP workflow progression. Must be resolved before proceeding. |
|
|
25
|
-
| **advisory** | Violations are REPORTED but workflow can continue with documented acceptance. |
|
|
26
|
-
|
|
27
|
-
---
|
|
28
|
-
|
|
29
|
-
## Applies-To Scope
|
|
30
|
-
|
|
31
|
-
| Scope | When Checked | What Is Validated |
|
|
32
|
-
|:------|:-------------|:------------------|
|
|
33
|
-
| **spec** | Phase 1B (Specification) | Specs address required concerns, ARC criteria included |
|
|
34
|
-
| **implementation** | Phase 2B (Verification) | Code meets requirements, patterns compliant |
|
|
35
|
-
| **both** | Phase 1B AND Phase 2B | Full coverage at both stages |
|
|
36
|
-
|
|
37
|
-
---
|
|
38
|
-
|
|
39
|
-
## Custom Guidelines
|
|
40
|
-
|
|
41
|
-
Add custom guidelines to `knowzcode/enterprise/guidelines/custom/` following the template in `templates/guideline-template.md`.
|
|
42
|
-
|
|
43
|
-
To activate a custom guideline, add it to the Active Guidelines table above.
|
|
44
|
-
|
|
45
|
-
---
|
|
46
|
-
|
|
47
|
-
## Configuration
|
|
48
|
-
|
|
49
|
-
```yaml
|
|
50
|
-
# Enable/disable compliance checking globally (default: false)
|
|
51
|
-
compliance_enabled: false
|
|
52
|
-
|
|
53
|
-
# Auto-run compliance during /kc:audit when enabled
|
|
54
|
-
include_in_audit: true
|
|
55
|
-
|
|
56
|
-
# Require compliance sign-off before Phase 3 finalization
|
|
57
|
-
require_signoff_for_finalization: false
|
|
58
|
-
|
|
59
|
-
# Show advisory issues in workflow output
|
|
60
|
-
show_advisory_issues: true
|
|
61
|
-
|
|
62
|
-
# Skip guidelines with empty content (default: true)
|
|
63
|
-
skip_empty_guidelines: true
|
|
64
|
-
```
|
|
65
|
-
|
|
66
|
-
---
|
|
67
|
-
|
|
68
|
-
## MCP-Based Compliance (Optional)
|
|
69
|
-
|
|
70
|
-
When MCP is configured with an enterprise vault, compliance can be enhanced with vault-based standards and audit trails.
|
|
71
|
-
|
|
72
|
-
```yaml
|
|
73
|
-
# Enable MCP-based compliance features (default: false)
|
|
74
|
-
mcp_compliance_enabled: false
|
|
75
|
-
|
|
76
|
-
# Enterprise vault ID for standards and audit trails
|
|
77
|
-
compliance_vault_id: ""
|
|
78
|
-
|
|
79
|
-
# Audit trail vault ID (can be same as compliance vault)
|
|
80
|
-
audit_trail_vault_id: ""
|
|
81
|
-
|
|
82
|
-
# Pull team-wide standards from enterprise vault at workflow start
|
|
83
|
-
pull_standards_at_start: true
|
|
84
|
-
|
|
85
|
-
# Push audit results to enterprise vault after Phase 2B
|
|
86
|
-
push_audit_results: true
|
|
87
|
-
|
|
88
|
-
# Push WorkGroup completion records to enterprise vault after Phase 3
|
|
89
|
-
push_completion_records: true
|
|
90
|
-
```
|
|
91
|
-
|
|
92
|
-
### How It Works
|
|
93
|
-
|
|
94
|
-
When `mcp_compliance_enabled: true`:
|
|
95
|
-
|
|
96
|
-
**At workflow start (before Phase 1A):**
|
|
97
|
-
- Query enterprise vault for team-wide standards: `ask_question(compliance_vault, "team standards for {project_type}")`
|
|
98
|
-
- Merge returned standards into quality gate criteria for the WorkGroup
|
|
99
|
-
|
|
100
|
-
**After Phase 2B audit:**
|
|
101
|
-
- Push audit results to enterprise vault: `create_knowledge(audit_trail_vault, "Audit: {wgid} - {score}%")`
|
|
102
|
-
- Include security findings, compliance status, and gap summary
|
|
103
|
-
|
|
104
|
-
**After Phase 3 finalization:**
|
|
105
|
-
- Push completion record: `create_knowledge(audit_trail_vault, "Completion: {wgid}")`
|
|
106
|
-
- Include goal, NodeIDs, audit score, key decisions, and architecture changes
|
|
107
|
-
|
|
108
|
-
### Agent-to-Enterprise-Vault Operations
|
|
109
|
-
|
|
110
|
-
| Agent | Operation | When | Content |
|
|
111
|
-
|-------|-----------|------|---------|
|
|
112
|
-
| analyst | create_knowledge | After 1A approval | Scope decisions, risk assessment |
|
|
113
|
-
| reviewer | create_knowledge | After 2B audit | Audit findings, security posture |
|
|
114
|
-
| closer | create_knowledge | After Phase 3 | Completion record, architecture changes |
|
|
115
|
-
| security-officer | search_knowledge | Stage 0, Stage 2 | Organization security standards, past security findings |
|
|
116
|
-
| test-advisor | (read-only) | Stage 2 | Enterprise ARC criteria for test coverage check |
|
|
117
|
-
| project-advisor | (read-only) | Stage 0 | Compliance config gaps for backlog proposals |
|
|
118
|
-
|
|
119
|
-
---
|
|
120
|
-
|
|
121
|
-
## Usage
|
|
122
|
-
|
|
123
|
-
### Check Compliance Status
|
|
124
|
-
```bash
|
|
125
|
-
/kc:audit compliance # Full review (spec + implementation)
|
|
126
|
-
/kc:audit compliance spec # Review specs only
|
|
127
|
-
/kc:audit compliance impl # Review implementation only
|
|
128
|
-
```
|
|
129
|
-
|
|
130
|
-
---
|
|
131
|
-
|
|
132
|
-
## Adding New Guidelines
|
|
133
|
-
|
|
134
|
-
1. Create guideline file in `guidelines/` or `guidelines/custom/`
|
|
135
|
-
2. Use `templates/guideline-template.md` as starting point
|
|
136
|
-
3. Add entry to Active Guidelines table above
|
|
137
|
-
4. Run `/kc:audit compliance` to verify guideline loads correctly
|
|
1
|
+
# Enterprise Compliance Manifest
|
|
2
|
+
|
|
3
|
+
> **Status: Experimental** — This feature is partially implemented. Security guidelines are functional; code-quality guidelines are templates only. No automated tests exist yet. Use at your own discretion.
|
|
4
|
+
|
|
5
|
+
**Purpose:** Defines which enterprise guidelines are active and their enforcement level.
|
|
6
|
+
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
## Active Guidelines
|
|
10
|
+
|
|
11
|
+
| Guideline File | Enforcement | Applies To | Active |
|
|
12
|
+
|:---------------|:------------|:-----------|:-------|
|
|
13
|
+
| security.md | blocking | both | false |
|
|
14
|
+
| code-quality.md | advisory | implementation | false |
|
|
15
|
+
|
|
16
|
+
> **Note:** Set `Active` to `true` to enable a guideline. Guidelines with empty content are skipped.
|
|
17
|
+
|
|
18
|
+
---
|
|
19
|
+
|
|
20
|
+
## Enforcement Levels
|
|
21
|
+
|
|
22
|
+
| Level | Behavior |
|
|
23
|
+
|:------|:---------|
|
|
24
|
+
| **blocking** | Violations STOP workflow progression. Must be resolved before proceeding. |
|
|
25
|
+
| **advisory** | Violations are REPORTED but workflow can continue with documented acceptance. |
|
|
26
|
+
|
|
27
|
+
---
|
|
28
|
+
|
|
29
|
+
## Applies-To Scope
|
|
30
|
+
|
|
31
|
+
| Scope | When Checked | What Is Validated |
|
|
32
|
+
|:------|:-------------|:------------------|
|
|
33
|
+
| **spec** | Phase 1B (Specification) | Specs address required concerns, ARC criteria included |
|
|
34
|
+
| **implementation** | Phase 2B (Verification) | Code meets requirements, patterns compliant |
|
|
35
|
+
| **both** | Phase 1B AND Phase 2B | Full coverage at both stages |
|
|
36
|
+
|
|
37
|
+
---
|
|
38
|
+
|
|
39
|
+
## Custom Guidelines
|
|
40
|
+
|
|
41
|
+
Add custom guidelines to `knowzcode/enterprise/guidelines/custom/` following the template in `templates/guideline-template.md`.
|
|
42
|
+
|
|
43
|
+
To activate a custom guideline, add it to the Active Guidelines table above.
|
|
44
|
+
|
|
45
|
+
---
|
|
46
|
+
|
|
47
|
+
## Configuration
|
|
48
|
+
|
|
49
|
+
```yaml
|
|
50
|
+
# Enable/disable compliance checking globally (default: false)
|
|
51
|
+
compliance_enabled: false
|
|
52
|
+
|
|
53
|
+
# Auto-run compliance during /kc:audit when enabled
|
|
54
|
+
include_in_audit: true
|
|
55
|
+
|
|
56
|
+
# Require compliance sign-off before Phase 3 finalization
|
|
57
|
+
require_signoff_for_finalization: false
|
|
58
|
+
|
|
59
|
+
# Show advisory issues in workflow output
|
|
60
|
+
show_advisory_issues: true
|
|
61
|
+
|
|
62
|
+
# Skip guidelines with empty content (default: true)
|
|
63
|
+
skip_empty_guidelines: true
|
|
64
|
+
```
|
|
65
|
+
|
|
66
|
+
---
|
|
67
|
+
|
|
68
|
+
## MCP-Based Compliance (Optional)
|
|
69
|
+
|
|
70
|
+
When MCP is configured with an enterprise vault, compliance can be enhanced with vault-based standards and audit trails.
|
|
71
|
+
|
|
72
|
+
```yaml
|
|
73
|
+
# Enable MCP-based compliance features (default: false)
|
|
74
|
+
mcp_compliance_enabled: false
|
|
75
|
+
|
|
76
|
+
# Enterprise vault ID for standards and audit trails
|
|
77
|
+
compliance_vault_id: ""
|
|
78
|
+
|
|
79
|
+
# Audit trail vault ID (can be same as compliance vault)
|
|
80
|
+
audit_trail_vault_id: ""
|
|
81
|
+
|
|
82
|
+
# Pull team-wide standards from enterprise vault at workflow start
|
|
83
|
+
pull_standards_at_start: true
|
|
84
|
+
|
|
85
|
+
# Push audit results to enterprise vault after Phase 2B
|
|
86
|
+
push_audit_results: true
|
|
87
|
+
|
|
88
|
+
# Push WorkGroup completion records to enterprise vault after Phase 3
|
|
89
|
+
push_completion_records: true
|
|
90
|
+
```
|
|
91
|
+
|
|
92
|
+
### How It Works
|
|
93
|
+
|
|
94
|
+
When `mcp_compliance_enabled: true`:
|
|
95
|
+
|
|
96
|
+
**At workflow start (before Phase 1A):**
|
|
97
|
+
- Query enterprise vault for team-wide standards: `ask_question(compliance_vault, "team standards for {project_type}")`
|
|
98
|
+
- Merge returned standards into quality gate criteria for the WorkGroup
|
|
99
|
+
|
|
100
|
+
**After Phase 2B audit:**
|
|
101
|
+
- Push audit results to enterprise vault: `create_knowledge(audit_trail_vault, "Audit: {wgid} - {score}%")`
|
|
102
|
+
- Include security findings, compliance status, and gap summary
|
|
103
|
+
|
|
104
|
+
**After Phase 3 finalization:**
|
|
105
|
+
- Push completion record: `create_knowledge(audit_trail_vault, "Completion: {wgid}")`
|
|
106
|
+
- Include goal, NodeIDs, audit score, key decisions, and architecture changes
|
|
107
|
+
|
|
108
|
+
### Agent-to-Enterprise-Vault Operations
|
|
109
|
+
|
|
110
|
+
| Agent | Operation | When | Content |
|
|
111
|
+
|-------|-----------|------|---------|
|
|
112
|
+
| analyst | create_knowledge | After 1A approval | Scope decisions, risk assessment |
|
|
113
|
+
| reviewer | create_knowledge | After 2B audit | Audit findings, security posture |
|
|
114
|
+
| closer | create_knowledge | After Phase 3 | Completion record, architecture changes |
|
|
115
|
+
| security-officer | search_knowledge | Stage 0, Stage 2 | Organization security standards, past security findings |
|
|
116
|
+
| test-advisor | (read-only) | Stage 2 | Enterprise ARC criteria for test coverage check |
|
|
117
|
+
| project-advisor | (read-only) | Stage 0 | Compliance config gaps for backlog proposals |
|
|
118
|
+
|
|
119
|
+
---
|
|
120
|
+
|
|
121
|
+
## Usage
|
|
122
|
+
|
|
123
|
+
### Check Compliance Status
|
|
124
|
+
```bash
|
|
125
|
+
/kc:audit compliance # Full review (spec + implementation)
|
|
126
|
+
/kc:audit compliance spec # Review specs only
|
|
127
|
+
/kc:audit compliance impl # Review implementation only
|
|
128
|
+
```
|
|
129
|
+
|
|
130
|
+
---
|
|
131
|
+
|
|
132
|
+
## Adding New Guidelines
|
|
133
|
+
|
|
134
|
+
1. Create guideline file in `guidelines/` or `guidelines/custom/`
|
|
135
|
+
2. Use `templates/guideline-template.md` as starting point
|
|
136
|
+
3. Add entry to Active Guidelines table above
|
|
137
|
+
4. Run `/kc:audit compliance` to verify guideline loads correctly
|
|
@@ -1,30 +1,30 @@
|
|
|
1
|
-
# Enterprise Compliance Status
|
|
2
|
-
|
|
3
|
-
**Purpose:** Track compliance review status per WorkGroup.
|
|
4
|
-
|
|
5
|
-
---
|
|
6
|
-
|
|
7
|
-
## Current WorkGroup
|
|
8
|
-
|
|
9
|
-
**WorkGroupID:** (none active)
|
|
10
|
-
**Last Review:** N/A
|
|
11
|
-
**Status:** N/A
|
|
12
|
-
|
|
13
|
-
---
|
|
14
|
-
|
|
15
|
-
## Review History
|
|
16
|
-
|
|
17
|
-
| Timestamp | WorkGroupID | Scope | Guidelines | Blocking | Advisory | Result |
|
|
18
|
-
|:----------|:------------|:------|:-----------|:---------|:---------|:-------|
|
|
19
|
-
| | | | | | | |
|
|
20
|
-
|
|
21
|
-
---
|
|
22
|
-
|
|
23
|
-
## Notes
|
|
24
|
-
|
|
25
|
-
This file is automatically updated by the reviewer agent during:
|
|
26
|
-
- Phase 1B spec compliance checks
|
|
27
|
-
- Phase 2B implementation compliance audits
|
|
28
|
-
- Standalone `/kc:audit compliance` reviews
|
|
29
|
-
|
|
30
|
-
Review history entries are appended chronologically with most recent at top.
|
|
1
|
+
# Enterprise Compliance Status
|
|
2
|
+
|
|
3
|
+
**Purpose:** Track compliance review status per WorkGroup.
|
|
4
|
+
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
## Current WorkGroup
|
|
8
|
+
|
|
9
|
+
**WorkGroupID:** (none active)
|
|
10
|
+
**Last Review:** N/A
|
|
11
|
+
**Status:** N/A
|
|
12
|
+
|
|
13
|
+
---
|
|
14
|
+
|
|
15
|
+
## Review History
|
|
16
|
+
|
|
17
|
+
| Timestamp | WorkGroupID | Scope | Guidelines | Blocking | Advisory | Result |
|
|
18
|
+
|:----------|:------------|:------|:-----------|:---------|:---------|:-------|
|
|
19
|
+
| | | | | | | |
|
|
20
|
+
|
|
21
|
+
---
|
|
22
|
+
|
|
23
|
+
## Notes
|
|
24
|
+
|
|
25
|
+
This file is automatically updated by the reviewer agent during:
|
|
26
|
+
- Phase 1B spec compliance checks
|
|
27
|
+
- Phase 2B implementation compliance audits
|
|
28
|
+
- Standalone `/kc:audit compliance` reviews
|
|
29
|
+
|
|
30
|
+
Review history entries are appended chronologically with most recent at top.
|
|
@@ -1,67 +1,67 @@
|
|
|
1
|
-
---
|
|
2
|
-
guideline_id: CQ-001
|
|
3
|
-
name: Code Quality Guidelines
|
|
4
|
-
enforcement: advisory
|
|
5
|
-
applies_to: implementation
|
|
6
|
-
priority: high
|
|
7
|
-
---
|
|
8
|
-
|
|
9
|
-
# Code Quality Guidelines
|
|
10
|
-
|
|
11
|
-
**Purpose:** Ensure code meets enterprise quality standards and design patterns.
|
|
12
|
-
|
|
13
|
-
> **Note:** This is a template. Add your organization's code quality requirements below.
|
|
14
|
-
> Empty sections are skipped during compliance review.
|
|
15
|
-
|
|
16
|
-
---
|
|
17
|
-
|
|
18
|
-
## 1. Design Patterns
|
|
19
|
-
|
|
20
|
-
<!-- Add required design patterns here -->
|
|
21
|
-
<!-- Example:
|
|
22
|
-
### CQ-PATTERN-01: Repository Pattern for Data Access
|
|
23
|
-
|
|
24
|
-
**Requirement:** All database access SHOULD use the Repository pattern.
|
|
25
|
-
|
|
26
|
-
**Applies To:** implementation
|
|
27
|
-
|
|
28
|
-
**Severity:** medium
|
|
29
|
-
|
|
30
|
-
**ARC Verification:**
|
|
31
|
-
- ARC_CQ_PATTERN_01a: Verify data access is encapsulated in repository classes
|
|
32
|
-
- ARC_CQ_PATTERN_01b: Verify controllers do not directly access database
|
|
33
|
-
-->
|
|
34
|
-
|
|
35
|
-
---
|
|
36
|
-
|
|
37
|
-
## 2. Error Handling
|
|
38
|
-
|
|
39
|
-
<!-- Add error handling standards here -->
|
|
40
|
-
|
|
41
|
-
---
|
|
42
|
-
|
|
43
|
-
## 3. Naming Conventions
|
|
44
|
-
|
|
45
|
-
<!-- Add naming convention requirements here -->
|
|
46
|
-
|
|
47
|
-
---
|
|
48
|
-
|
|
49
|
-
## 4. Code Structure
|
|
50
|
-
|
|
51
|
-
<!-- Add code structure requirements here -->
|
|
52
|
-
|
|
53
|
-
---
|
|
54
|
-
|
|
55
|
-
## 5. Testing Standards
|
|
56
|
-
|
|
57
|
-
<!-- Add testing requirements here -->
|
|
58
|
-
|
|
59
|
-
---
|
|
60
|
-
|
|
61
|
-
## Compliance Summary
|
|
62
|
-
|
|
63
|
-
| ID | Requirement | Severity | Scope |
|
|
64
|
-
|:---|:------------|:---------|:------|
|
|
65
|
-
<!-- Add your requirements summary here -->
|
|
66
|
-
|
|
67
|
-
---
|
|
1
|
+
---
|
|
2
|
+
guideline_id: CQ-001
|
|
3
|
+
name: Code Quality Guidelines
|
|
4
|
+
enforcement: advisory
|
|
5
|
+
applies_to: implementation
|
|
6
|
+
priority: high
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
# Code Quality Guidelines
|
|
10
|
+
|
|
11
|
+
**Purpose:** Ensure code meets enterprise quality standards and design patterns.
|
|
12
|
+
|
|
13
|
+
> **Note:** This is a template. Add your organization's code quality requirements below.
|
|
14
|
+
> Empty sections are skipped during compliance review.
|
|
15
|
+
|
|
16
|
+
---
|
|
17
|
+
|
|
18
|
+
## 1. Design Patterns
|
|
19
|
+
|
|
20
|
+
<!-- Add required design patterns here -->
|
|
21
|
+
<!-- Example:
|
|
22
|
+
### CQ-PATTERN-01: Repository Pattern for Data Access
|
|
23
|
+
|
|
24
|
+
**Requirement:** All database access SHOULD use the Repository pattern.
|
|
25
|
+
|
|
26
|
+
**Applies To:** implementation
|
|
27
|
+
|
|
28
|
+
**Severity:** medium
|
|
29
|
+
|
|
30
|
+
**ARC Verification:**
|
|
31
|
+
- ARC_CQ_PATTERN_01a: Verify data access is encapsulated in repository classes
|
|
32
|
+
- ARC_CQ_PATTERN_01b: Verify controllers do not directly access database
|
|
33
|
+
-->
|
|
34
|
+
|
|
35
|
+
---
|
|
36
|
+
|
|
37
|
+
## 2. Error Handling
|
|
38
|
+
|
|
39
|
+
<!-- Add error handling standards here -->
|
|
40
|
+
|
|
41
|
+
---
|
|
42
|
+
|
|
43
|
+
## 3. Naming Conventions
|
|
44
|
+
|
|
45
|
+
<!-- Add naming convention requirements here -->
|
|
46
|
+
|
|
47
|
+
---
|
|
48
|
+
|
|
49
|
+
## 4. Code Structure
|
|
50
|
+
|
|
51
|
+
<!-- Add code structure requirements here -->
|
|
52
|
+
|
|
53
|
+
---
|
|
54
|
+
|
|
55
|
+
## 5. Testing Standards
|
|
56
|
+
|
|
57
|
+
<!-- Add testing requirements here -->
|
|
58
|
+
|
|
59
|
+
---
|
|
60
|
+
|
|
61
|
+
## Compliance Summary
|
|
62
|
+
|
|
63
|
+
| ID | Requirement | Severity | Scope |
|
|
64
|
+
|:---|:------------|:---------|:------|
|
|
65
|
+
<!-- Add your requirements summary here -->
|
|
66
|
+
|
|
67
|
+
---
|