You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: .agents/skills/write-pr-description/SKILL.md
+28-2Lines changed: 28 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -39,6 +39,9 @@ Use this shape unless the change is truly trivial:
39
39
40
40
## Tests / notes
41
41
<short bullet list or prose: what you verified, anything reviewers should watch for>
42
+
43
+
## What to QA
44
+
<only for user-visible changes: short steps for the manual tester, see section 7>
42
45
```
43
46
44
47
Adapt the headings if the situation calls for it (e.g. a pure feature PR might use "What this adds" instead of "What was broken"). The order stays the same: the obeservation (symptom or user-visible change first or intent), then the changes, then verification and validation.
@@ -102,7 +105,26 @@ Keep this section short and concrete. Useful contents:
102
105
103
106
Skip the section entirely if there is nothing real to say. A blank "Tests" heading is worse than no heading.
104
107
105
-
## 7. Reviewer's first-30-seconds test
108
+
## 7. What to QA section
109
+
110
+
If the change is user-visible and a teammate will test it manually, add a "What to QA" section. Write it for a tester who knows the product and has context: skip the basics, point at the right screens, and state the expected result of every check.
111
+
112
+
- One line per check: where to go, what to do, what they should see.
113
+
- Name the exact pages and flows. "Test the feature" is not a check.
114
+
- Include the regression to watch for: the thing this change is most likely to have broken.
115
+
- If a check needs setup (a seeded project, an older record, a feature flag), say so in the same line.
116
+
- Use simple, clear language. Same prose rules as section 5.
117
+
118
+
Example:
119
+
120
+
> ## What to QA
121
+
> - Create a new automatic evaluator, name it, save. The table shows your name with a v1 tag, not "default".
122
+
> - Edit it and commit a config change. The name stays, the version bumps to v2.
123
+
> - Regression: run a new evaluation. The variant chips still say "default", not the app name.
124
+
125
+
Skip the section when nothing is user-visible (pure refactor, CI, docs). A reviewer-only change needs the Tests section, not this one.
126
+
127
+
## 8. Reviewer's first-30-seconds test
106
128
107
129
Before you finalize, read your own draft and ask:
108
130
@@ -113,7 +135,7 @@ Before you finalize, read your own draft and ask:
113
135
114
136
If any answer is no, edit before you push.
115
137
116
-
## 8. Worked example
138
+
## 9. Worked example
117
139
118
140
A bad first draft:
119
141
@@ -147,6 +169,10 @@ After:
147
169
## Tests
148
170
- Added a unit test in parseToolsFromTrace.test.ts covering both shapes.
149
171
- Opened a real OpenInference trace from the staging project and confirmed the tools panel renders.
172
+
173
+
## What to QA
174
+
- Open an OpenInference trace in the playground (the staging project has them). The tools panel lists the tools.
175
+
- Regression: open a trace from the OpenAI SDK. The tools panel still renders as before.
150
176
```
151
177
152
178
The second version is cleaner and tells the reviewer everything they need to start reading the diff.
Copy file name to clipboardExpand all lines: .claude/agents/changelog-editor.md
+17-11Lines changed: 17 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,10 +9,17 @@ You are an expert technical documentation editor specializing in Docusaurus chan
9
9
10
10
## Your Core Responsibilities
11
11
12
-
1.**Dual Entry Creation**: For every changelog item, you create two coordinated entries:
13
-
- A concise summary in `docs/main.mdx`
14
-
- A detailed explanation in `docs/block/entries/[version-or-feature].mdx`
15
-
- The summary title must link to the detailed entry
12
+
1.**Entry Creation**: For every changelog item, you create one entry file in
13
+
`docs/blog/entries/[version-or-feature].mdx`. The changelog index page at
14
+
`/changelog` is generated automatically from these files (sorted by `date`,
15
+
paginated). Each entry holds two texts: a curated short summary wrapped in
16
+
`<Summary>...</Summary>`, then a `{/* truncate */}` marker, then the full
17
+
write-up. `<Summary>` shows only on the index (as the preview, with a "Read
18
+
more" link) and renders nothing on the entry page, so the page shows just
19
+
the full write-up. The short summary can differ from the long write-up's
20
+
opening; do not just copy its first lines. If the feature has a demo video
21
+
or screenshot, put it inside `<Summary>` (so it shows on the index) and
22
+
again in the write-up below the marker (so it shows on the entry page).
16
23
17
24
2.**Version Management**: Before creating any entry, determine the version number. If unclear from context, ask the user: "Which version is this changelog entry for?" Never proceed without a clear version identifier.
18
25
@@ -62,8 +69,8 @@ You are an expert technical documentation editor specializing in Docusaurus chan
62
69
63
70
**Quality Control Checklist (apply to every entry):**
64
71
-[ ] Version number present and correct
65
-
-[ ]Both short and detailed entries created
66
-
-[ ]Short entry links to detailed entry correctly
72
+
-[ ]Entry created in `docs/blog/entries/`
73
+
-[ ]Curated summary in `<Summary>`, then `{/* truncate */}`, then the full write-up
67
74
-[ ] Active voice used where possible
68
75
-[ ] No em dashes present
69
76
-[ ] Feature documentation linked if applicable
@@ -74,10 +81,9 @@ You are an expert technical documentation editor specializing in Docusaurus chan
74
81
## Output Format
75
82
76
83
When creating or editing changelog entries, provide:
77
-
1. The complete markdown for the main.mdx summary entry
78
-
2. The complete markdown for the detailed entries/[name].mdx file
79
-
3. Confirmation that you've checked for related documentation
80
-
4. Build test results
81
-
5. Any questions or clarifications needed
84
+
1. The complete markdown for the entries/[name].mdx file
85
+
2. Confirmation that you've checked for related documentation
86
+
3. Build test results
87
+
4. Any questions or clarifications needed
82
88
83
89
Be proactive in identifying unclear requirements and ask specific questions rather than making assumptions. Your goal is to produce changelog entries that are immediately publishable without requiring revision.
[Optional: What's coming next or related features]
226
255
```
227
256
228
-
### Step 4: Add Summary to main.mdx
229
-
Add to `/docs/blog/main.mdx` at the TOP (after imports):
230
-
231
-
```mdx
232
-
### [Feature Name](/changelog/feature-slug)
257
+
### Step 4: Write the Summary and Place the Truncate Marker
233
258
234
-
_DD Month YYYY_
259
+
The `/changelog` index shows the `<Summary>` block (with a "Read more" link);
260
+
the entry page shows everything below `{/* truncate */}`. So:
235
261
236
-
**vX.Y.Z**
237
-
238
-
[1-2 paragraph summary explaining what the feature does and why users should care. Focus on benefits and capabilities.]
239
-
240
-
[Optional: Add embedded video or image if this is a major feature]
241
-
242
-
---
243
-
```
262
+
- Put the curated short summary inside `<Summary>...</Summary>`, then the
263
+
`{/* truncate */}` marker, then the full write-up.
264
+
- Leave blank lines inside the `<Summary>` tags so the content parses as
265
+
Markdown (links and bold work).
266
+
- If there is a demo video or screenshot, include it inside `<Summary>` (so it
267
+
shows on the index) and again in the write-up below the marker (so it shows
268
+
on the entry page).
269
+
- Every entry needs content below the marker (the full write-up); that is what
270
+
the entry page renders.
244
271
245
272
### Step 5: Add Sidebar Announcement
246
273
Add to `/web/oss/src/components/SidebarBanners/data/changelog.json`:
@@ -406,21 +433,6 @@ Learn more in our documentation:
406
433
We're continuing to enhance session tracking with upcoming features like session-level annotations, session comparisons, and automated session analysis.
407
434
```
408
435
409
-
**Summary Entry** (add to `docs/blog/main.mdx`):
410
-
```mdx
411
-
### [Chat Sessions in Observability](/changelog/chat-sessions-observability)
412
-
413
-
_9 January 2026_
414
-
415
-
**v0.73.0**
416
-
417
-
You can now track multi-turn conversations with chat sessions. All traces with the same session ID are automatically grouped together, letting you analyze complete conversations instead of individual requests.
418
-
419
-
The new session browser shows key metrics like total cost, latency, and token usage per conversation. Open any session to see all traces with their parent-child relationships. This makes debugging chatbots and AI assistants much easier. Add session tracking with one line of code using either our Python SDK or OpenTelemetry.
420
-
421
-
---
422
-
```
423
-
424
436
**Sidebar Announcement**:
425
437
```json
426
438
{
@@ -463,21 +475,20 @@ The new session browser shows key metrics like total cost, latency, and token us
463
475
464
476
When creating a changelog announcement, provide:
465
477
466
-
1.**Detailed entry content** for `docs/blog/entries/[slug].mdx`
467
-
2.**Summary entry content** to add to `docs/blog/main.mdx`
468
-
3.**Sidebar announcement JSON** to add to `changelog.json`
469
-
4.**Confirmation** that you checked for related documentation
470
-
5.**Any questions** or clarifications needed
478
+
1.**Entry content** for `docs/blog/entries/[slug].mdx` (curated summary in `<Summary>`, then `{/* truncate */}`, then the full write-up)
479
+
2.**Sidebar announcement JSON** to add to `changelog.json`
480
+
3.**Confirmation** that you checked for related documentation
481
+
4.**Any questions** or clarifications needed
471
482
472
483
**Be proactive** in identifying unclear requirements. Ask specific questions rather than making assumptions. Your goal is to produce changelog entries that are immediately publishable without requiring revision.
473
484
474
485
## Tips for Success
475
486
476
-
1.**Read existing entries first**: Before creating new entries, read 2-3 recent entries in `main.mdx` and `entries/` to match the tone and structure
487
+
1.**Read existing entries first**: Before creating new entries, read 2-3 recent entries in `entries/` to match the tone and structure
477
488
2.**Be concise**: Users skim changelogs. Front-load the benefit in every sentence.
478
489
3.**Link generously**: Help users find more information easily
479
490
4.**Test your work**: Read the entries out loud to catch awkward phrasing
480
-
5.**Consistency matters**: Ensure terminology matches across all three entries
491
+
5.**Consistency matters**: Ensure terminology matches between the entry and the sidebar announcement
0 commit comments