Skip to content

Commit 497c589

Browse files
committed
Merge branch staging/pfv6 into chore/skill-readme-instructions
2 parents 5186cda + 98a4efc commit 497c589

2 files changed

Lines changed: 13 additions & 5 deletions

File tree

.claude/skills/review-api/SKILL.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -106,6 +106,7 @@ Read `.claude/ADVICE.md` for reference rules.
106106
- [ ] `static styles = [styles]` array form?
107107
- [ ] Controllers for cross-cutting concerns?
108108
- [ ] `isServer` guards on browser-only APIs?
109+
- [ ] Quoting attribute values in Lit templates `src="{$this.src}"`?
109110

110111
#### Lint
111112
```bash
@@ -124,13 +125,16 @@ npx stylelint elements/pf-v6-{name}/**/*.css
124125
- [ ] No arrow functions in test blocks?
125126
- [ ] Behavioral expectations from React tests covered?
126127

127-
### Phase 5: JSDoc
128+
### Phase 5: JSDoc and cem documentation comments
128129

129130
- [ ] `@summary` present on element class?
130131
- [ ] All public properties/methods have `/** */` JSDoc (not `//` comments)?
131-
- [ ] `@cssprop` with CSS data types: `@cssprop {color} --pf-v6-c-button--Color`?
132-
- [ ] `@csspart` for all exposed parts?
133-
- [ ] `@slot` for all slots (prescriptive descriptions)?
132+
- [ ] CSS custom properties documented with `/** */` comments in the CSS file,
133+
co-located with the declaration or `var()` reference?
134+
- [ ] CSS parts documented with `<!-- summary: ... -->` HTML comments before the
135+
`part="..."` element in the template?
136+
- [ ] Slots documented with `<!-- summary: ... -->` HTML comments before the `<slot>`
137+
element in the template?
134138
- [ ] `@fires` for all dispatched events?
135139
- [ ] No unnecessary `@default` tags (analyzer picks up initializers)?
136140

.claude/skills/update-element/SKILL.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -291,7 +291,11 @@ whether values are actually configurable or hardcoded.
291291

292292
See `elements/pf-v6-tooltip/README.md` for a reference example.
293293

294-
### Phase 9: Audit
294+
### Phase 9: Delete v5 element
295+
296+
Delete the directory and it's contents from ./elements/`pf-v5-{name}`. replace all references to `pf-v5-{name}`, except historical changelogs, and update their usage to conform to new APIs. This includes demos for v6 elements which use v5 dependencies.
297+
298+
### Phase 10: Audit
295299

296300
Prompt the user to activate /review-api, /review-demos, and /review-a11y
297301

0 commit comments

Comments
 (0)