File tree Expand file tree Collapse file tree
.claude/skills/review-api Expand file tree Collapse file tree Original file line number Diff line number Diff line change @@ -124,13 +124,16 @@ npx stylelint elements/pf-v6-{name}/**/*.css
124124- [ ] No arrow functions in test blocks?
125125- [ ] Behavioral expectations from React tests covered?
126126
127- ### Phase 5: JSDoc
127+ ### Phase 5: JSDoc and cem documentation comments
128128
129129- [ ] ` @summary ` present on element class?
130130- [ ] 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)?
131+ - [ ] CSS custom properties documented with ` /** */ ` comments in the CSS file,
132+ co-located with the declaration or ` var() ` reference?
133+ - [ ] CSS parts documented with ` <!-- summary: ... --> ` HTML comments before the
134+ ` part="..." ` element in the template?
135+ - [ ] Slots documented with ` <!-- summary: ... --> ` HTML comments before the ` <slot> `
136+ element in the template?
134137- [ ] ` @fires ` for all dispatched events?
135138- [ ] No unnecessary ` @default ` tags (analyzer picks up initializers)?
136139
You can’t perform that action at this time.
0 commit comments