@fractary/core 0.7.24 → 0.7.25

package/templates/docs/standards/template.md

@@ -0,0 +1,54 @@
+# {{title}}
+
+## Overview
+
+{{overview}}
+
+## Scope
+
+{{scope}}
+
+## Standards
+
+{{#standards}}
+### {{name}}
+
+{{description}}
+
+{{#rules}}
+#### {{title}}
+
+{{description}}
+
+{{#examples}}
+**{{type}}:**
+```{{language}}
+{{code}}
+```
+{{/examples}}
+
+{{/rules}}
+
+{{/standards}}
+
+## Exceptions
+
+{{#exceptions}}
+- **{{context}}**: {{description}}
+{{/exceptions}}
+
+## Enforcement
+
+{{enforcement}}
+
+## References
+
+{{#references}}
+- [{{title}}]({{url}})
+{{/references}}
+
+## Changelog
+
+{{#changelog}}
+- **{{date}}**: {{change}}
+{{/changelog}}

package/templates/docs/standards/type.yaml

@@ -0,0 +1,61 @@
+# Standards & Conventions Type Definition
+
+id: standards
+display_name: Standards & Conventions
+description: Coding standards, style guides, and team conventions
+
+output_path: docs/standards
+
+file_naming:
+  pattern: "STD-{slug}.md"
+  slug_source: title
+  slug_max_length: 50
+
+frontmatter:
+  required_fields:
+    - title
+    - type
+    - status
+    - date
+  optional_fields:
+    - owner
+    - applies_to
+    - tags
+    - related
+    - version
+  defaults:
+    type: standards
+    status: draft
+
+structure:
+  required_sections:
+    - Overview
+    - Standards
+  optional_sections:
+    - Scope
+    - Exceptions
+    - Enforcement
+    - References
+    - Changelog
+  section_order:
+    - Overview
+    - Scope
+    - Standards
+    - Exceptions
+    - Enforcement
+    - References
+    - Changelog
+
+status:
+  allowed_values:
+    - draft
+    - review
+    - approved
+    - deprecated
+  default: draft
+
+index_config:
+  index_file: docs/standards/README.md
+  sort_by: title
+  sort_order: asc
+  entry_template: "- [{{title}}]({{relative_path}}) - {{status}}"

package/templates/docs/testing/standards.md

@@ -0,0 +1,15 @@
+# Testing Documentation Standards
+
+## Required Conventions
+
+- ALWAYS define test scope
+- ALWAYS document test cases with steps
+- ALWAYS include expected results
+- ALWAYS track test status
+
+## Best Practices
+
+- Use unique test case IDs
+- Document test environment
+- Track issues found
+- Get sign-off for releases

package/templates/docs/testing/template.md

@@ -0,0 +1,87 @@
+# {{title}}
+
+## Overview
+
+{{overview}}
+
+## Test Scope
+
+### In Scope
+
+{{#in_scope}}
+- {{.}}
+{{/in_scope}}
+
+### Out of Scope
+
+{{#out_of_scope}}
+- {{.}}
+{{/out_of_scope}}
+
+## Test Environment
+
+{{environment}}
+
+## Test Cases
+
+{{#test_cases}}
+### {{id}}: {{title}}
+
+**Priority:** {{priority}}
+**Type:** {{type}}
+
+**Preconditions:**
+{{#preconditions}}
+- {{.}}
+{{/preconditions}}
+
+**Steps:**
+{{#steps}}
+1. {{.}}
+{{/steps}}
+
+**Expected Result:**
+{{expected_result}}
+
+**Status:** {{status}}
+
+{{/test_cases}}
+
+## Test Data
+
+{{test_data}}
+
+## Results Summary
+
+| Metric | Value |
+|--------|-------|
+| Total Tests | {{results.total}} |
+| Passed | {{results.passed}} |
+| Failed | {{results.failed}} |
+| Skipped | {{results.skipped}} |
+| Pass Rate | {{results.pass_rate}} |
+
+## Issues Found
+
+{{#issues}}
+### {{id}}: {{title}}
+
+**Severity:** {{severity}}
+**Status:** {{status}}
+
+{{description}}
+{{/issues}}
+
+## Recommendations
+
+{{#recommendations}}
+- {{.}}
+{{/recommendations}}
+
+## Sign-off
+
+| Role | Name | Date | Status |
+|------|------|------|--------|
+{{#signoffs}}
+| {{role}} | {{name}} | {{date}} | {{status}} |
+{{/signoffs}}

package/templates/docs/testing/type.yaml

@@ -0,0 +1,65 @@
+# Testing Documentation Type Definition
+
+id: testing
+display_name: Testing Documentation
+description: Test plans, test results, and QA documentation
+
+output_path: docs/testing
+
+file_naming:
+  pattern: "TEST-{slug}.md"
+  slug_source: title
+  slug_max_length: 50
+
+frontmatter:
+  required_fields:
+    - title
+    - type
+    - status
+    - date
+  optional_fields:
+    - tester
+    - version
+    - tags
+    - related
+    - test_type
+  defaults:
+    type: testing
+    status: draft
+
+structure:
+  required_sections:
+    - Overview
+    - Test Scope
+    - Test Cases
+    - Results Summary
+  optional_sections:
+    - Test Environment
+    - Test Data
+    - Issues Found
+    - Recommendations
+    - Sign-off
+  section_order:
+    - Overview
+    - Test Scope
+    - Test Environment
+    - Test Cases
+    - Test Data
+    - Results Summary
+    - Issues Found
+    - Recommendations
+    - Sign-off
+
+status:
+  allowed_values:
+    - draft
+    - in_progress
+    - completed
+    - signed_off
+  default: draft
+
+index_config:
+  index_file: docs/testing/README.md
+  sort_by: date
+  sort_order: desc
+  entry_template: "- [{{title}}]({{relative_path}}) - {{status}} ({{results.pass_rate}})"

package/templates/logs/audit/standards.md

@@ -0,0 +1,33 @@
+# Audit Log Standards
+
+## Required Conventions
+
+### 1. Immutability
+- NEVER modify existing audit log entries
+- ALWAYS create new entries for updates or corrections
+- ALWAYS preserve original timestamps
+
+### 2. Completeness
+- ALWAYS include user/actor who performed the action
+- ALWAYS include the action performed
+- ALWAYS include the resource affected
+- ALWAYS include timestamps in ISO 8601 format
+
+### 3. Classification
+- ALWAYS set appropriate audit_type (security, compliance, performance, access, change)
+- ALWAYS set severity level (info, warning, critical)
+- ALWAYS escalate critical events immediately
+
+### 4. Evidence
+- ALWAYS include supporting evidence for critical events
+- ALWAYS reference related logs or tickets
+- ALWAYS document the source of the event
+
+## Best Practices
+
+- Use unique audit_id format: `AUDIT-{timestamp}-{random}`
+- Include IP addresses and session info for access events
+- Link to related compliance requirements
+- Set appropriate retention based on severity (critical = forever)
+- Review audit logs periodically for patterns
+- Never log sensitive data (passwords, tokens) in plain text

package/templates/logs/audit/template.md

@@ -0,0 +1,65 @@
+---
+log_type: audit
+title: {{title}}
+audit_id: {{audit_id}}
+date: {{date}}
+status: {{status}}
+audit_type: {{audit_type}}
+severity: {{severity}}
+{{#user}}
+user: {{user}}
+{{/user}}
+{{#action}}
+action: {{action}}
+{{/action}}
+{{#resource}}
+resource: {{resource}}
+{{/resource}}
+{{#work_id}}
+work_id: {{work_id}}
+{{/work_id}}
+{{#tags}}
+tags:
+{{#tags}}
+  - {{.}}
+{{/tags}}
+{{/tags}}
+---
+
+# Audit: {{title}}
+
+## Event Details
+
+- **Type**: {{audit_type}}
+- **Severity**: {{severity}}
+{{#user}}
+- **User**: {{user}}
+{{/user}}
+{{#action}}
+- **Action**: {{action}}
+{{/action}}
+{{#resource}}
+- **Resource**: {{resource}}
+{{/resource}}
+
+## Context
+
+{{context}}
+
+{{#impact}}
+## Impact Assessment
+
+{{impact}}
+{{/impact}}
+
+{{#evidence}}
+## Evidence
+
+{{evidence}}
+{{/evidence}}
+
+{{#recommended_actions}}
+## Recommended Actions
+
+{{recommended_actions}}
+{{/recommended_actions}}

package/templates/logs/audit/type.yaml

@@ -0,0 +1,85 @@
+# Audit Log Type Definition
+#
+# This file defines the schema, frontmatter rules, and configuration
+# for audit and compliance log entries.
+
+id: audit
+display_name: Audit Log
+description: Security events, access logs, compliance tracking, change audits
+
+# Output configuration
+output_path: .fractary/logs/audit
+
+# File naming rules
+file_naming:
+  pattern: "{date}-{audit_id}.md"
+  date_format: "YYYYMMDD-HHmmss"
+  slug_source: audit_id
+  slug_max_length: 36
+
+# Frontmatter schema
+frontmatter:
+  required_fields:
+    - log_type
+    - title
+    - audit_id
+    - date
+    - status
+    - audit_type
+    - severity
+  optional_fields:
+    - user
+    - action
+    - resource
+    - work_id
+    - tags
+  defaults:
+    log_type: audit
+    status: active
+
+# Document structure
+structure:
+  required_sections:
+    - Event Details
+    - Context
+  optional_sections:
+    - Impact Assessment
+    - Evidence
+    - Recommended Actions
+  section_order:
+    - Event Details
+    - Context
+    - Impact Assessment
+    - Evidence
+    - Recommended Actions
+
+# Status workflow
+status:
+  allowed_values:
+    - active
+    - completed
+    - archived
+  default: active
+
+# Audit type classification
+audit_type:
+  allowed_values:
+    - security
+    - compliance
+    - performance
+    - access
+    - change
+  default: security
+
+# Severity levels
+severity:
+  allowed_values:
+    - info
+    - warning
+    - critical
+  default: info
+
+# Retention policy
+retention:
+  default_local_days: 90
+  default_cloud_days: forever

package/templates/logs/build/standards.md

@@ -0,0 +1,32 @@
+# Build Log Standards
+
+## Required Conventions
+
+### 1. Identification
+- ALWAYS include unique build_id
+- ALWAYS include commit SHA when building from git
+- ALWAYS include branch name
+
+### 2. Status Tracking
+- ALWAYS update status as build progresses (pending -> running -> success/failure)
+- ALWAYS include exit code on completion
+- ALWAYS record duration in seconds
+
+### 3. Output Capture
+- ALWAYS capture full build output
+- ALWAYS include error messages and stack traces on failure
+- ALWAYS preserve output formatting
+
+### 4. Artifacts
+- ALWAYS list artifacts with full paths
+- ALWAYS include artifact sizes when available
+- ALWAYS note if artifacts were uploaded to storage
+
+## Best Practices
+
+- Use unique build_id format: `BUILD-{timestamp}-{random}`
+- Truncate extremely long outputs with "[truncated]" marker
+- Link builds to related issues/PRs via work_id
+- Include environment variables that affect the build (sanitized)
+- Record memory and CPU usage if available
+- Archive build logs for successful production builds longer

package/templates/logs/build/template.md

@@ -0,0 +1,78 @@
+---
+log_type: build
+title: {{title}}
+build_id: {{build_id}}
+date: {{date}}
+status: {{status}}
+{{#repository}}
+repository: {{repository}}
+{{/repository}}
+{{#branch}}
+branch: {{branch}}
+{{/branch}}
+{{#commit_sha}}
+commit_sha: {{commit_sha}}
+{{/commit_sha}}
+{{#build_tool}}
+build_tool: {{build_tool}}
+{{/build_tool}}
+{{#exit_code}}
+exit_code: {{exit_code}}
+{{/exit_code}}
+{{#duration_seconds}}
+duration_seconds: {{duration_seconds}}
+{{/duration_seconds}}
+{{#artifacts}}
+artifacts:
+{{#artifacts}}
+  - {{.}}
+{{/artifacts}}
+{{/artifacts}}
+{{#work_id}}
+work_id: {{work_id}}
+{{/work_id}}
+{{#tags}}
+tags:
+{{#tags}}
+  - {{.}}
+{{/tags}}
+{{/tags}}
+---
+
+# Build: {{title}}
+
+## Configuration
+
+- **Tool**: {{build_tool}}
+{{#command}}
+- **Command**: `{{command}}`
+{{/command}}
+{{#repository}}
+- **Repository**: {{repository}}
+{{/repository}}
+{{#branch}}
+- **Branch**: {{branch}}
+{{/branch}}
+{{#commit_sha}}
+- **Commit**: {{commit_sha}}
+{{/commit_sha}}
+
+## Output
+
+```
+{{output}}
+```
+
+{{#artifacts}}
+## Artifacts
+
+{{#artifacts}}
+- {{.}}
+{{/artifacts}}
+{{/artifacts}}
+
+{{#summary}}
+## Summary
+
+{{summary}}
+{{/summary}}

package/templates/logs/build/type.yaml

@@ -0,0 +1,71 @@
+# Build Log Type Definition
+#
+# This file defines the schema, frontmatter rules, and configuration
+# for build process log entries.
+
+id: build
+display_name: Build Log
+description: CI/CD builds, compilation output, npm/cargo/make builds, build failures
+
+# Output configuration
+output_path: .fractary/logs/build
+
+# File naming rules
+file_naming:
+  pattern: "{date}-{build_id}.md"
+  date_format: "YYYYMMDD-HHmmss"
+  slug_source: build_id
+  slug_max_length: 36
+
+# Frontmatter schema
+frontmatter:
+  required_fields:
+    - log_type
+    - title
+    - build_id
+    - date
+    - status
+  optional_fields:
+    - repository
+    - branch
+    - commit_sha
+    - build_tool
+    - exit_code
+    - duration_seconds
+    - artifacts
+    - work_id
+    - tags
+  defaults:
+    log_type: build
+    status: pending
+
+# Document structure
+structure:
+  required_sections:
+    - Configuration
+    - Output
+  optional_sections:
+    - Artifacts
+    - Summary
+  section_order:
+    - Configuration
+    - Output
+    - Artifacts
+    - Summary
+
+# Status workflow
+status:
+  allowed_values:
+    - pending
+    - running
+    - success
+    - failure
+    - cancelled
+  default: pending
+
+# Retention policy
+retention:
+  default_local_days: 14
+  default_cloud_days: 30
+  auto_archive: true
+  cleanup_after_archive: true

package/templates/logs/changelog/standards.md

@@ -0,0 +1,34 @@
+# Changelog Log Standards
+
+## Required Conventions
+
+### 1. Versioning
+- ALWAYS use semantic versioning (MAJOR.MINOR.PATCH)
+- ALWAYS specify the version affected by the change
+- ALWAYS increment version appropriately for change type
+
+### 2. Change Types (Keep a Changelog format)
+- **added**: New features
+- **changed**: Changes in existing functionality
+- **fixed**: Bug fixes
+- **removed**: Removed features
+- **deprecated**: Soon-to-be removed features
+- **security**: Security vulnerability fixes
+
+### 3. Breaking Changes
+- ALWAYS mark breaking changes explicitly
+- ALWAYS provide migration instructions for breaking changes
+- ALWAYS include before/after examples for API changes
+
+### 4. Linking
+- ALWAYS reference related issues and PRs
+- ALWAYS link to superseded changes if applicable
+
+## Best Practices
+
+- Use unique change_id format: `CHANGE-{timestamp}-{random}`
+- Write changes from user perspective, not developer perspective
+- Group related changes into single changelog entries
+- Keep changelog entries permanent (historical record)
+- Use conventional commit format for consistency
+- Include deprecation timeline for deprecated features