codex-genesis-harness 0.1.5 → 0.1.7

package/.codex/skills/genesis-docs-automation/templates/changelog-entry-template.md

@@ -1,187 +1,187 @@
-# Template: Changelog Entry
-
-**Copy this template for new changelog entries**
-
----
-
-## [v2.X] - YYYY-MM-DD
-
-### ✨ Added
-
-**[Feature Name]** [NEW]
-- [Main benefit/description]
-- Details:
-  - [Detail 1]
-  - [Detail 2]
-  - [Detail 3]
-- Backward compatible: ✅ YES / ❌ NO
-- **See**: [API Reference](API_REFERENCE.md#section) | [Implementation](IMPLEMENTATION.md#section)
-- **Tests**: [test-file.ts](path/to/test.ts) with [N] test cases
-- **Coverage**: [%]
-- **Performance**: [metric if relevant]
-
-**New Error Codes**:
-| Code | Message | When |
-|------|---------|------|
-| XXX | Description | Condition |
-
----
-
-### 🔄 Changed
-
-**[Behavior Change]**
-- **Before**: [Old behavior description]
-- **After**: [New behavior description]
-- **Why**: [Reason for change]
-- **Impact**: [How does this affect users - breaking? transparent? performance impact?]
-- **Workaround**: [If breaking, what should users do?]
-- **Migration**: [Link to migration guide if needed]
-- **Tests**: [test-file.ts](path/to/test.ts) updated
-
----
-
-### 🐛 Fixed
-
-**[Bug Description]** 
-- **Issue**: [What was broken]
-  - Root cause: [Why it happened]
-  - Symptoms: [How it manifested]
-  - Affected: [Which users/versions]
-- **Fix**: [How it's resolved]
-  - Code: [Where the fix is]
-  - Tests: [Regression tests added]
-- **Workaround**: [For users on affected version]
-- **Upgrade**: Recommended (or Critical)
-- **Related**: [Issue #XXX](link)
-
----
-
-### ⚠️ Deprecated
-
-**[Feature Name]** [DEPRECATED]
-- **Timeline**: Removed in v2.X (planned for YYYY-MM-DD)
-- **Alternative**: [What to use instead]
-- **Why**: [Reason for deprecation]
-- **Migration Guide**: [Link to migration](#migration-feature-name)
-- **Deprecation Header**: API returns `Deprecation: true` header with date
-
-### 🗑️ Removed
-
-**[Feature Name]**
-- **Reason**: [Why was it removed]
-- **Alternative**: [What to use instead]
-- **Migration**: [Link to migration guide](#migration-feature-name)
-- **Last Version**: [Last version that included this feature]
-
----
-
-### 🔐 Security
-
-**[Security Issue Name]** [CRITICAL / HIGH / MEDIUM]
-- **Vulnerability**: [Type of security issue]
-- **Risk**: [What could happen]
-- **Affected**: [Who is affected - versions, users, conditions]
-- **Fix**: [How it's addressed]
-- **Recommendation**: [Upgrade immediately / within X days]
-- **CVE**: [CVE number if applicable]
-- **References**: [Security advisory links]
-
----
-
-### 📚 Documentation
-
-**[Documentation Improvement]**
-- **What**: [What was improved/added]
-- **Where**: [Link to documentation]
-- **Why**: [Why this improvement was needed]
-
----
-
-## Migration Guides
-
-### Migration: [Feature Name]
-
-**When to Migrate**: [Now / Before vX.X release]
-**Breaking**: YES / NO
-**Effort**: [5 min / 30 min / 2 hours]
-
-**What's Changing**:
-- [Change 1]
-- [Change 2]
-- [Change 3]
-
-**Before (v2.X)**:
-```code
-// old code example
-```
-
-**After (v2.X+)**:
-```code
-// new code example
-```
-
-**Why**: [Reason for change]
-
-**Steps to Migrate**:
-1. [Step 1]
-2. [Step 2]
-3. [Step 3]
-
-**Testing**:
-- [ ] Old code removed
-- [ ] New code tested
-- [ ] Tests passing
-
-**Troubleshooting**:
-| Issue | Cause | Solution |
-|-------|-------|----------|
-| [Error message] | [Root cause] | [How to fix] |
-
----
-
-## Release Notes
-
-**v2.X - YYYY-MM-DD**
-
-- ✨ [Feature 1]
-- ✨ [Feature 2]
-- 🔄 [Changed behavior]
-- 🐛 [Bug fixed]
-- ⚠️ [Deprecation notice]
-- 📚 [Documentation improvement]
-
-**Dependencies Updated**:
-- [Package]: X.X.X → X.X.X (reason for update)
-
-**Breaking Changes**: YES / NO
-- If YES: [List and link to migration guides]
-
-**Known Issues**:
-- [Issue 1]: [Workaround if available]
-- [Issue 2]: [Timeline for fix if known]
-
-**Upgrade**: [Recommended / Critical / Optional]
-
----
-
-## Meta Information
-
-- **Date**: YYYY-MM-DD HH:MM UTC
-- **Author**: [Generated by genesis-docs-automation]
-- **Files Changed**: [N]
-- **Docs Files Updated**: [N]
-- **Tests Added**: [N]
-- **Breaking**: YES / NO
-- **Security Impact**: YES / NO / CRITICAL
-- **Manual Review Required**: YES / NO
-
----
-
-**Instructions for use**:
-1. Copy this template
-2. Fill in all [bracketed] sections
-3. Delete unused sections (e.g., if no "🐛 Fixed", remove that section)
-4. Keep sections in order as shown
-5. Use consistent formatting (markdown, code blocks)
-6. Include links to relevant documentation/tests
-7. Test all code examples to ensure they work
+# Template: Changelog Entry
+
+**Copy this template for new changelog entries**
+
+---
+
+## [v2.X] - YYYY-MM-DD
+
+### ✨ Added
+
+**[Feature Name]** [NEW]
+- [Main benefit/description]
+- Details:
+  - [Detail 1]
+  - [Detail 2]
+  - [Detail 3]
+- Backward compatible: ✅ YES / ❌ NO
+- **See**: [API Reference](API_REFERENCE.md#section) | [Implementation](IMPLEMENTATION.md#section)
+- **Tests**: [test-file.ts](path/to/test.ts) with [N] test cases
+- **Coverage**: [%]
+- **Performance**: [metric if relevant]
+
+**New Error Codes**:
+| Code | Message | When |
+|------|---------|------|
+| XXX | Description | Condition |
+
+---
+
+### 🔄 Changed
+
+**[Behavior Change]**
+- **Before**: [Old behavior description]
+- **After**: [New behavior description]
+- **Why**: [Reason for change]
+- **Impact**: [How does this affect users - breaking? transparent? performance impact?]
+- **Workaround**: [If breaking, what should users do?]
+- **Migration**: [Link to migration guide if needed]
+- **Tests**: [test-file.ts](path/to/test.ts) updated
+
+---
+
+### 🐛 Fixed
+
+**[Bug Description]** 
+- **Issue**: [What was broken]
+  - Root cause: [Why it happened]
+  - Symptoms: [How it manifested]
+  - Affected: [Which users/versions]
+- **Fix**: [How it's resolved]
+  - Code: [Where the fix is]
+  - Tests: [Regression tests added]
+- **Workaround**: [For users on affected version]
+- **Upgrade**: Recommended (or Critical)
+- **Related**: [Issue #XXX](link)
+
+---
+
+### ⚠️ Deprecated
+
+**[Feature Name]** [DEPRECATED]
+- **Timeline**: Removed in v2.X (planned for YYYY-MM-DD)
+- **Alternative**: [What to use instead]
+- **Why**: [Reason for deprecation]
+- **Migration Guide**: [Link to migration](#migration-feature-name)
+- **Deprecation Header**: API returns `Deprecation: true` header with date
+
+### 🗑️ Removed
+
+**[Feature Name]**
+- **Reason**: [Why was it removed]
+- **Alternative**: [What to use instead]
+- **Migration**: [Link to migration guide](#migration-feature-name)
+- **Last Version**: [Last version that included this feature]
+
+---
+
+### 🔐 Security
+
+**[Security Issue Name]** [CRITICAL / HIGH / MEDIUM]
+- **Vulnerability**: [Type of security issue]
+- **Risk**: [What could happen]
+- **Affected**: [Who is affected - versions, users, conditions]
+- **Fix**: [How it's addressed]
+- **Recommendation**: [Upgrade immediately / within X days]
+- **CVE**: [CVE number if applicable]
+- **References**: [Security advisory links]
+
+---
+
+### 📚 Documentation
+
+**[Documentation Improvement]**
+- **What**: [What was improved/added]
+- **Where**: [Link to documentation]
+- **Why**: [Why this improvement was needed]
+
+---
+
+## Migration Guides
+
+### Migration: [Feature Name]
+
+**When to Migrate**: [Now / Before vX.X release]
+**Breaking**: YES / NO
+**Effort**: [5 min / 30 min / 2 hours]
+
+**What's Changing**:
+- [Change 1]
+- [Change 2]
+- [Change 3]
+
+**Before (v2.X)**:
+```code
+// old code example
+```
+
+**After (v2.X+)**:
+```code
+// new code example
+```
+
+**Why**: [Reason for change]
+
+**Steps to Migrate**:
+1. [Step 1]
+2. [Step 2]
+3. [Step 3]
+
+**Testing**:
+- [ ] Old code removed
+- [ ] New code tested
+- [ ] Tests passing
+
+**Troubleshooting**:
+| Issue | Cause | Solution |
+|-------|-------|----------|
+| [Error message] | [Root cause] | [How to fix] |
+
+---
+
+## Release Notes
+
+**v2.X - YYYY-MM-DD**
+
+- ✨ [Feature 1]
+- ✨ [Feature 2]
+- 🔄 [Changed behavior]
+- 🐛 [Bug fixed]
+- ⚠️ [Deprecation notice]
+- 📚 [Documentation improvement]
+
+**Dependencies Updated**:
+- [Package]: X.X.X → X.X.X (reason for update)
+
+**Breaking Changes**: YES / NO
+- If YES: [List and link to migration guides]
+
+**Known Issues**:
+- [Issue 1]: [Workaround if available]
+- [Issue 2]: [Timeline for fix if known]
+
+**Upgrade**: [Recommended / Critical / Optional]
+
+---
+
+## Meta Information
+
+- **Date**: YYYY-MM-DD HH:MM UTC
+- **Author**: [Generated by genesis-docs-automation]
+- **Files Changed**: [N]
+- **Docs Files Updated**: [N]
+- **Tests Added**: [N]
+- **Breaking**: YES / NO
+- **Security Impact**: YES / NO / CRITICAL
+- **Manual Review Required**: YES / NO
+
+---
+
+**Instructions for use**:
+1. Copy this template
+2. Fill in all [bracketed] sections
+3. Delete unused sections (e.g., if no "🐛 Fixed", remove that section)
+4. Keep sections in order as shown
+5. Use consistent formatting (markdown, code blocks)
+6. Include links to relevant documentation/tests
+7. Test all code examples to ensure they work