Skip to content

Commit e75cf0e

Browse files
iobuhovclaude
andcommitted
refactor(openspec): prune template comments to one-liners
Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
1 parent c6049df commit e75cf0e

3 files changed

Lines changed: 10 additions & 67 deletions

File tree

Lines changed: 2 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,50 +1,28 @@
11
## Test Cases
22

3-
<!--
4-
Define test cases that will verify the fix or refactoring.
5-
6-
For bugs: Start with a reproduction test (currently failing), then edge cases.
7-
For refactoring: Tests should verify existing behavior is preserved.
8-
-->
3+
<!-- For bugs: start with reproduction test. For refactoring: verify existing behavior preserved. -->
94

105
### Reproduction Tests
116

12-
<!--
13-
For bugs: Tests that reproduce the issue (will fail initially)
14-
-->
15-
167
- Test name - Description (unit/integration/e2e)
178
- **Given**: Setup/preconditions
189
- **When**: Action/trigger
1910
- **Then**: Expected outcome
2011

2112
### Edge Cases
2213

23-
<!--
24-
Related edge cases that should also be tested
25-
-->
26-
2714
- Test name - Description (unit/integration/e2e)
2815
- **Given**: Setup/preconditions
2916
- **When**: Action/trigger
3017
- **Then**: Expected outcome
3118

3219
### Regression Tests
3320

34-
<!--
35-
Tests to ensure related functionality isn't broken
36-
-->
37-
3821
- Test name - Description (unit/integration/e2e)
3922
- **Given**: Setup/preconditions
4023
- **When**: Action/trigger
4124
- **Then**: Expected outcome
4225

4326
## Notes
4427

45-
<!--
46-
Track observations during testing:
47-
- Unexpected behaviors discovered
48-
- Additional edge cases found
49-
- Test failures and resolutions
50-
-->
28+
<!-- Track unexpected behaviors, additional edge cases found, test failures and resolutions. -->
Lines changed: 4 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,15 @@
11
## Why
22

3-
<!--
4-
For bugs: What's broken? What's the observed vs. expected behavior?
5-
For refactoring: What problem does current code have? Tech debt, maintainability, performance?
6-
7-
This is for FIXES and REFACTORING. For new features, use spec-driven schema instead.
8-
-->
3+
<!-- For bugs: observed vs expected behavior. For refactoring: tech debt or maintainability issue. -->
94

105
## Root Cause
116

12-
<!--
13-
For bugs: Technical reason for the bug (if known).
14-
For refactoring: What makes the current code problematic?
15-
-->
7+
<!-- Technical reason for the bug or what makes current code problematic. -->
168

179
## What Changes
1810

19-
<!--
20-
Be specific about what will be fixed or refactored.
21-
- Which files/components are affected?
22-
- What code structure changes?
23-
- Any behavior changes? (Mark breaking changes with **BREAKING**)
24-
25-
For refactoring: behavior changes should be minimal or zero.
26-
-->
11+
<!-- Which files/components affected? Mark breaking changes with **BREAKING**. -->
2712

2813
## Impact
2914

30-
<!--
31-
Who/what is affected by this change?
32-
- Affected code, APIs, users, or systems
33-
- Breaking changes? Migration needed?
34-
- Test coverage needed?
35-
-->
15+
<!-- Affected code, APIs, users. Breaking changes? Migration needed? -->
Lines changed: 4 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,48 +1,33 @@
11
## 1. Test Setup
22

3-
<!--
4-
RED phase: Write failing tests first
5-
-->
3+
<!-- RED: Write failing tests first -->
64

75
- [ ] 1.1 Write failing test for main issue
86
- [ ] 1.2 Add edge case tests
97
- [ ] 1.3 Add regression tests for related functionality
108

119
## 2. Implementation
1210

13-
<!--
14-
GREEN phase: Make tests pass with minimal code
15-
-->
11+
<!-- GREEN: Make tests pass with minimal code -->
1612

1713
- [ ] 2.1 Fix core issue (make main test pass)
1814
- [ ] 2.2 Handle edge cases (make edge tests pass)
1915
- [ ] 2.3 Verify no regressions
2016

2117
## 3. Refactoring
2218

23-
<!--
24-
REFACTOR phase: Clean up while keeping tests green
25-
-->
19+
<!-- REFACTOR: Clean up while keeping tests green -->
2620

2721
- [ ] 3.1 Clean up implementation
2822
- [ ] 3.2 Extract common logic/improve structure
2923
- [ ] 3.3 Remove duplication
3024

3125
## 4. Verification
3226

33-
<!--
34-
Final checks before completing
35-
-->
36-
3727
- [ ] 4.1 All tests passing (including new tests)
3828
- [ ] 4.2 Full test suite passes (no regressions)
3929
- [ ] 4.3 Code review ready (clean, documented)
4030

4131
## Notes
4232

43-
<!--
44-
Track TDD cycle observations:
45-
- Test failures and what they revealed
46-
- Refactoring decisions made
47-
- Blockers encountered and resolutions
48-
-->
33+
<!-- Track test failures, refactoring decisions, blockers. -->

0 commit comments

Comments
 (0)