Skip to content

Commit ec7547b

Browse files
Rankush Kumarclaude
andcommitted
docs(contact-center): address PR review feedback on templates
Changes based on reviewer feedback on PR #4722: - Fix validation commands in all 4 templates to use actual workspace scripts: test:styles, test:unit, build:src - Clarify event contract "Emitted/Received On" field to explicitly ask which object (cc, task, taskManager) the event is emitted/received on Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent 664c11f commit ec7547b

File tree

4 files changed

+17
-27
lines changed

4 files changed

+17
-27
lines changed

packages/@webex/contact-center/ai-docs/templates/existing-service/bug-fix.md

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -227,17 +227,14 @@ describe('methodName - Bug Fix', () => {
227227

228228
#### Verification
229229
```bash
230-
# Type check
231-
yarn workspace @webex/contact-center typecheck
232-
233230
# Lint
234-
yarn workspace @webex/contact-center lint
231+
yarn workspace @webex/contact-center test:styles
235232

236233
# All tests
237-
yarn workspace @webex/contact-center test
234+
yarn workspace @webex/contact-center test:unit
238235

239236
# Build
240-
yarn workspace @webex/contact-center build
237+
yarn workspace @webex/contact-center build:src
241238
```
242239

243240
---

packages/@webex/contact-center/ai-docs/templates/existing-service/feature-enhancement.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -97,9 +97,9 @@ For each new or updated API call, ask:
9797
|---|---|
9898
| Event Name | "What is the event name?" |
9999
| Direction | "Is this incoming (WebSocket) or outgoing (emitted by SDK)?" |
100-
| Listen/Emit Object | "Where do consumers subscribe?" (`cc`, `task`, `taskManager`, service) |
100+
| Emitted/Received On | "On which object is this event emitted or received?" (`cc`, `task`, `taskManager`, or a service instance) |
101101
| Payload Type/Shape | "What data does the event carry?" |
102-
| Emitted From | "Which class/file emits this?" |
102+
| Emitted From | "Which class/file emits this event?" |
103103
| Emission Trigger | "What causes this event to fire?" |
104104

105105
- If NO: note "No events"
@@ -428,10 +428,9 @@ If feature is significant, update the root [`AGENTS.md`](../../../AGENTS.md):
428428
- [ ] Documentation updated
429429

430430
```bash
431-
yarn workspace @webex/contact-center typecheck
432-
yarn workspace @webex/contact-center lint
433-
yarn workspace @webex/contact-center test
434-
yarn workspace @webex/contact-center build
431+
yarn workspace @webex/contact-center test:styles
432+
yarn workspace @webex/contact-center test:unit
433+
yarn workspace @webex/contact-center build:src
435434
```
436435

437436
---

packages/@webex/contact-center/ai-docs/templates/new-method/04-validation.md

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -92,17 +92,14 @@ throw detailedError;
9292
## Build & Test Verification
9393

9494
```bash
95-
# Type check
96-
yarn workspace @webex/contact-center typecheck
97-
9895
# Lint
99-
yarn workspace @webex/contact-center lint
96+
yarn workspace @webex/contact-center test:styles
10097

101-
# Test
102-
yarn workspace @webex/contact-center test
98+
# Test unit tests
99+
yarn workspace @webex/contact-center test:unit
103100

104101
# Build
105-
yarn workspace @webex/contact-center build
102+
yarn workspace @webex/contact-center build:src
106103
```
107104

108105
All should pass without errors.

packages/@webex/contact-center/ai-docs/templates/new-service/05-validation.md

Lines changed: 5 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -84,17 +84,14 @@ export type {
8484
## Build & Test Verification
8585

8686
```bash
87-
# Type check
88-
yarn workspace @webex/contact-center typecheck
89-
9087
# Lint
91-
yarn workspace @webex/contact-center lint
88+
yarn workspace @webex/contact-center test:styles
9289

93-
# Build
94-
yarn workspace @webex/contact-center build
90+
# Test unit tests
91+
yarn workspace @webex/contact-center test:unit
9592

96-
# Test
97-
yarn workspace @webex/contact-center test
93+
# Build
94+
yarn workspace @webex/contact-center build:src
9895
```
9996

10097
All should pass without errors.

0 commit comments

Comments
 (0)