@tianhai/pi-workflow-kit 2.6.0 → 2.7.0
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/package.json
CHANGED
|
@@ -179,8 +179,11 @@ key files capped `at 5`.
|
|
|
179
179
|
|
|
180
180
|
```markdown
|
|
181
181
|
# Progress: <topic>
|
|
182
|
+
|
|
182
183
|
Design: docs/plans/<date>-<topic>/<leaf>-design.md
|
|
184
|
+
|
|
183
185
|
Feature phase: e2e-written
|
|
186
|
+
|
|
184
187
|
## Requirements
|
|
185
188
|
| # | Done | Requirement | Per-req ceremony | Commit |
|
|
186
189
|
## Execution summary
|
|
@@ -2,16 +2,21 @@
|
|
|
2
2
|
|
|
3
3
|
Read before creating or changing progress rows, or writing/re-presenting the code digest. This reference owns the unchanged progress artifact schema.
|
|
4
4
|
|
|
5
|
-
2. **Create the progress file** `docs/plans/<date>-<topic>/<leaf>-progress.md`, beside the design doc it belongs to (`<leaf>` is `<topic>` for a single-part topic; an umbrella part uses its roster slug), so `pwk-finalizing` finds it inside the topic folder:
|
|
5
|
+
2. **Create the progress file** `docs/plans/<date>-<topic>/<leaf>-progress.md`, beside the design doc it belongs to (`<leaf>` is `<topic>` for a single-part topic; an umbrella part uses its roster slug), so `pwk-finalizing` finds it inside the topic folder. Keep the blank lines between the header fields: the blank lines are load-bearing, because CommonMark merges consecutive plain lines into one paragraph, so without them every preview renders the whole header as a single run-on line.
|
|
6
6
|
|
|
7
7
|
```markdown
|
|
8
8
|
# Progress: <topic>
|
|
9
9
|
|
|
10
10
|
Design: docs/plans/<date>-<topic>/<leaf>-design.md
|
|
11
|
+
|
|
11
12
|
Branch: <branch>
|
|
13
|
+
|
|
12
14
|
Setup: n/a
|
|
15
|
+
|
|
13
16
|
Started: <ISO timestamp>
|
|
17
|
+
|
|
14
18
|
Last updated: <ISO timestamp>
|
|
19
|
+
|
|
15
20
|
Feature phase: e2e-written
|
|
16
21
|
|
|
17
22
|
<!-- a trivial design doc (no `## Feature acceptance`) starts at `implementing (0/N)` instead — there is no E2E to write -->
|
|
@@ -266,7 +266,9 @@ def build(args):
|
|
|
266
266
|
('Diff', git(project, 'diff', '--no-ext-diff', '--no-textconv', '--no-color', span, *pathspec)),
|
|
267
267
|
]
|
|
268
268
|
label = 'feature review' if args.scope == 'feature' else f'requirement R{args.requirement} review'
|
|
269
|
-
|
|
269
|
+
# The blank line between Base and Head is load-bearing: CommonMark merges
|
|
270
|
+
# consecutive plain lines into one paragraph in every preview.
|
|
271
|
+
packet = f'# Review packet: {design_path.parent.name} — {label}\n\nBase: {base}\n\nHead: {head}\n\n'
|
|
270
272
|
for title, content in sections:
|
|
271
273
|
packet += f'## {title}\n\n{content}\n'
|
|
272
274
|
# All parsing and Git reads finish before a temporary file exists. A failure in
|