Skip to content

chore: improve phase 5 cem alignment documentation comments #3146

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
bennypowers merged 1 commit into from
May 13, 2026
+7 −4
Merged

chore: improve phase 5 cem alignment documentation comments #3146

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 7 additions & 4 deletions .claude/skills/review-api/SKILL.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -124,13 +124,16 @@ npx stylelint elements/pf-v6-{name}/**/*.css
- [ ] No arrow functions in test blocks?
- [ ] Behavioral expectations from React tests covered?

### Phase 5: JSDoc
### Phase 5: JSDoc and cem documentation comments

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

Expand Down
Loading