Skip to content

Commit 9216aaf

Browse files
fix: Improve documentation formatting by removing unnecessary code block syntax and enhancing clarity in the execution flow and summary sections
1 parent 827d022 commit 9216aaf

File tree

1 file changed

+14
-12
lines changed

1 file changed

+14
-12
lines changed

specs/001-building-on-this/plan.md

Lines changed: 14 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,6 @@
55

66
## Execution Flow (/plan command scope)
77

8-
```plaintext
98
1. Load feature spec from Input path
109
→ If not found: ERROR "No feature spec at {path}"
1110
2. Fill Technical Context (scan for NEEDS CLARIFICATION)
@@ -26,7 +25,6 @@
2625
→ Update Progress Tracking: Post-Design Constitution Check
2726
8. Plan Phase 2 → Describe task generation approach (DO NOT create tasks.md)
2827
9. STOP - Ready for /tasks command
29-
```
3028

3129
**IMPORTANT**: The /plan command STOPS at step 7. Phases 2-4 are executed by other commands:
3230

@@ -35,7 +33,13 @@
3533

3634
## Summary
3735

38-
Extract BeforeAll/AfterAll test setup/teardown logic from Test-ModuleLocal.yml into a reusable local composite action. This reduces workflow duplication, improves maintainability, and enables reuse across workflows. The single composite action will accept a mode parameter (before/after) to control which script to execute (BeforeAll.ps1 or AfterAll.ps1) and error handling behavior. The action will be located at `.github/actions/setup-test/action.yml` and will integrate with existing PSModule/GitHub-Script and PSModule/Install-PSModuleHelpers actions. Documentation will clearly explain that BeforeAll/AfterAll scripts are intended for managing external test resources (cloud infrastructure, external databases, third-party services) that are independent of the test platform/OS, while test-specific resources should be created within the tests themselves.
36+
Extract BeforeAll/AfterAll test setup/teardown logic from Test-ModuleLocal.yml into a reusable local composite action. This reduces workflow
37+
duplication, improves maintainability, and enables reuse across workflows. The single composite action will accept a mode parameter (before/after) to
38+
control which script to execute (BeforeAll.ps1 or AfterAll.ps1) and error handling behavior. The action will be located at
39+
`.github/actions/setup-test/action.yml` and will integrate with existing PSModule/GitHub-Script and PSModule/Install-PSModuleHelpers actions.
40+
Documentation will clearly explain that BeforeAll/AfterAll scripts are intended for managing external test resources (cloud infrastructure, external
41+
databases, third-party services) that are independent of the test platform/OS, while test-specific resources should be created within the tests
42+
themselves.
3943

4044
## Technical Context
4145

@@ -132,7 +136,7 @@ Extract BeforeAll/AfterAll test setup/teardown logic from Test-ModuleLocal.yml i
132136

133137
### Documentation (this feature)
134138

135-
```
139+
```plaintext
136140
specs/001-building-on-this/
137141
├── spec.md # Feature specification (already exists)
138142
├── plan.md # This file (/plan command output)
@@ -145,7 +149,7 @@ specs/001-building-on-this/
145149

146150
### Source Code (repository root)
147151

148-
```
152+
```plaintext
149153
Process-PSModule/
150154
├── .github/
151155
│ ├── actions/
@@ -172,13 +176,11 @@ Process-PSModule/
172176
- Best practices for mode-based behavior in actions
173177
- Integration patterns with existing PSModule actions
174178
2. **Generate and dispatch research agents**:
175-
```
176-
Task 1: "Research GitHub composite action structure and syntax best practices"
177-
Task 2: "Research error handling patterns in GitHub composite actions (continue-on-error, fail-fast)"
178-
Task 3: "Research mode/parameter-based behavior patterns in reusable actions"
179-
Task 4: "Research integration patterns for PSModule/GitHub-Script and PSModule/Install-PSModuleHelpers"
180-
Task 5: "Review current Test-ModuleLocal.yml BeforeAll/AfterAll implementation for exact behavior"
181-
```
179+
- Task 1: "Research GitHub composite action structure and syntax best practices"
180+
- Task 2: "Research error handling patterns in GitHub composite actions (continue-on-error, fail-fast)"
181+
- Task 3: "Research mode/parameter-based behavior patterns in reusable actions"
182+
- Task 4: "Research integration patterns for PSModule/GitHub-Script and PSModule/Install-PSModuleHelpers"
183+
- Task 5: "Review current Test-ModuleLocal.yml BeforeAll/AfterAll implementation for exact behavior"
182184
3. **Consolidate findings** in `research.md` using format:
183185
- Decision: [what was chosen]
184186
- Rationale: [why chosen]

0 commit comments

Comments
 (0)