chore(quantic): creation of new managing quantic components skill by mmitiche · Pull Request #7596 · coveo/ui-kit

mmitiche · 2026-05-19T18:32:41Z

SFINT-6773

Summary

This PR adds the managing-quantic-components agent skill following the Agent Skills format
The skill is structured with progressive disclosure, a compact SKILL.md for quick reference, and three focused reference files loaded only when needed:

SKILL.md (~160 lines): Non-negotiable conventions table, canonical file ordering, directory layout, Definition of Done checklist, and working workflow
headless-and-lifecycle.md: Scaffolding, headless engine integration, error handling, Bueno validation, store registration, shared utilities
ui-patterns.md : Label management (including i18n, pluralization, translations), template directives, CSS/SLDS patterns, event dispatch/listening, multi-template rendering
docs-accessibility-testing.md: JSDoc documentation requirements, AriaLiveRegion accessibility, testing strategy

What's next

This is the first iteration, we'll refine the skill as we observe how agents use it in practice. One planned improvement is extracting a dedicated testing skill (Jest unit tests + Playwright E2E) to keep this skill focused on component authoring and avoid overcrowding it.

changeset-bot · 2026-05-19T18:32:48Z

⚠️ No Changeset found

Latest commit: 228c8b8

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

svcsnykcoveo · 2026-05-19T18:32:57Z

✅ Snyk checks have passed. No issues have been found so far.

Status	Scan Engine	Critical	High	Medium	Low	Total (0)
✅	Open Source Security	0	0	0	0	0 issues
✅	Licenses	0	0	0	0	0 issues
✅	Code Security	0	0	0	0	0 issues

💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse.

chromatic-com · 2026-05-19T18:40:04Z

Important

Testing in progress…

🟢 UI Tests: 366 tests unchanged
⏳ UI Review: Comparing 366 stories…
Storybook Publish: 366 stories published

chromatic-com · 2026-05-19T18:40:04Z

Tip

All tests passed and all changes approved!

🟢 UI Tests: 366 tests unchanged
🟢 UI Review: 366 stories published -- no changes
Storybook Publish: 366 stories published

pkg-pr-new · 2026-05-19T18:40:25Z

coveo-atomic-pkg-new-template

@coveo/atomic

npm i https://pkg.pr.new/@coveo/atomic@7596

@coveo/atomic-hosted-page

npm i https://pkg.pr.new/@coveo/atomic-hosted-page@7596

@coveo/atomic-legacy

npm i https://pkg.pr.new/@coveo/atomic-legacy@7596

@coveo/atomic-react

npm i https://pkg.pr.new/@coveo/atomic-react@7596

@coveo/auth

npm i https://pkg.pr.new/@coveo/auth@7596

@coveo/bueno

npm i https://pkg.pr.new/@coveo/bueno@7596

@coveo/create-atomic

npm i https://pkg.pr.new/@coveo/create-atomic@7596

@coveo/create-atomic-component

npm i https://pkg.pr.new/@coveo/create-atomic-component@7596

@coveo/create-atomic-component-project

npm i https://pkg.pr.new/@coveo/create-atomic-component-project@7596

@coveo/create-atomic-result-component

npm i https://pkg.pr.new/@coveo/create-atomic-result-component@7596

@coveo/create-atomic-rollup-plugin

npm i https://pkg.pr.new/@coveo/create-atomic-rollup-plugin@7596

@coveo/headless

npm i https://pkg.pr.new/@coveo/headless@7596

@coveo/headless-react

npm i https://pkg.pr.new/@coveo/headless-react@7596

@coveo/shopify

npm i https://pkg.pr.new/@coveo/shopify@7596

commit: 327aeb0

github-actions · 2026-05-19T18:42:40Z

🔗 Scratch Orgs ready to test this PR:

✅ LWS Enabled: Open Org
✅ LWS Disabled: Open Org

Copilot

Pull request overview

Adds a new agent skill managing-quantic-components under .agents/skills/ documenting conventions, lifecycle, UI patterns, accessibility, docs, and testing rules for Quantic LWC components, and whitelists the spelling of onquantic in cspell.

Changes:

New SKILL.md with quick reference, conventions table, ordering rules, Definition of Done, and progressive-disclosure links to three reference files.
Three reference docs covering headless integration/lifecycle, UI/label/event patterns, and docs/accessibility/testing.
.cspell.json updated to allow onquantic (used in LWC event-listener attribute examples).

Reviewed changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated 2 comments.

Show a summary per file

File	Description
.agents/skills/managing-quantic-components/SKILL.md	Top-level skill entry with conventions, ordering, DoD, and references.
.agents/skills/managing-quantic-components/references/headless-and-lifecycle.md	Scaffolding, headless integration, error handling, Bueno, store registration.
.agents/skills/managing-quantic-components/references/ui-patterns.md	Labels (i18n/pluralization), template directives, CSS, events, multi-template.
.agents/skills/managing-quantic-components/references/docs-accessibility-testing.md	JSDoc requirements, AriaLiveRegion accessibility, testing strategy.
.cspell.json	Whitelists `onquantic` token used in event-listener attribute examples.

+
+### Documentation Requirements
+
+Quantic reference docs are generated from component JSDoc. Every component class and `@api` property must be documented. See the full rules, valid categories, and code templates in **Section 8** of `references/quantic-component-workflow.md`.


+For the testing strategy rationale, see [packages/quantic/decisions/0001-testing-strategy.md](../../../decisions/0001-testing-strategy.md).
+
+- **Jest unit tests** — Isolated component behavior, rendering, lifecycle, and headless interactions with mocks. When writing tests, examine an existing test file for a similar component and follow its mock scaffolding, selector patterns, and assertion style.
+- **Playwright E2E tests** — Real user workflows, analytics, API interactions, and Salesforce integration. See [packages/quantic/docs/adding-tests.md](../../../docs/adding-tests.md) for the full walkthrough.


erocheleau

lgtm, just a bit weird the cspell.json file?

erocheleau · 2026-05-19T20:50:01Z

+ * @fires quantic__eventname
+ * @slot slot-name - Description of the slot.
+ * @example
+ * <c-quantic-component-name engine-id={engineId} with-toggle></c-quantic-component-name>


Do you know if we need to specify that the names are always using kebab-case etc?

erocheleau · 2026-05-19T21:07:30Z

+.generated-answer__card-header { }
+```
+
+### Custom properties (SLDS design tokens)


I would perhaps add that we should always include a fallback whenever we're using a SLDS design token, because they're not always available everywhere?

erocheleau · 2026-05-19T21:08:37Z

+
+## Multi-Template Components
+
+Components with multiple visual states override `render()`:


Not sure about the "multiple visual states" ?
But if an agent understands it then it's okay I guess

erocheleau · 2026-05-19T21:10:11Z

+### Testing Strategy
+
+Follow the package split:
+
+- Jest unit tests verify isolated component behavior, rendering, lifecycle, and Headless interactions with mocks
+- Playwright E2E tests verify real user workflows, analytics, API interactions, accessibility flows, and Salesforce integration behavior
+
+Do not duplicate upstream Headless coverage unless the Quantic component adds behavior on top.


I think this is duplicated under the ui-patterns.md file?

erocheleau · 2026-05-19T21:10:51Z

+    "στόμα",
+    "onquantic"


what is that? lol

The spell check pre-commit hook was telling me onquantic was a typo preventing my commit, so I added it to this list of recognized words.

SimonMilord · 2026-05-20T18:58:54Z

+Before marking any task as complete, verify every applicable item and output this table:
+
+
+| Check | Status |


should we add a check in the list for accessibility related stuff?

SimonMilord

Looks good and exhaustive. Just wondering any use in having the AI use the sf cli commands for example to create a initial boilerplate component or do we want to leave it to the LLM to manage that on its own?

mmitiche added 8 commits May 18, 2026 10:47

initial version of the Quantic skill

ac35c6e

improvements to skill for handing labels and creating components

574c3b3

Definition of Done added to skill

4a47edc

rule added to skill

388a3a0

another label variant rule

240af95

minor modifications

6801d1f

methods js doc instructions added

405cfa7

refactored skill

327aeb0

mmitiche temporarily deployed to pr-workflows May 19, 2026 18:32 — with GitHub Actions Inactive

mmitiche temporarily deployed to PR Artifacts May 19, 2026 18:32 — with GitHub Actions Inactive

Merge branch 'main' into SFINT-6773

228c8b8

mmitiche temporarily deployed to pr-workflows May 19, 2026 18:33 — with GitHub Actions Inactive

mmitiche temporarily deployed to PR Artifacts May 19, 2026 18:33 — with GitHub Actions Inactive

coveo-code-areas-pr-checks Bot added area:agents team:dxui labels May 19, 2026

mmitiche temporarily deployed to PR Artifacts May 19, 2026 18:53 — with GitHub Actions Inactive

mmitiche marked this pull request as ready for review May 19, 2026 20:32

mmitiche requested review from a team, Copilot and y-lakhdar May 19, 2026 20:32

mmitiche requested review from fbeaudoincoveo and louis-bompart May 19, 2026 20:32

Copilot started reviewing on behalf of mmitiche May 19, 2026 20:32 View session

Copilot AI reviewed May 19, 2026

View reviewed changes

erocheleau approved these changes May 19, 2026

View reviewed changes

SimonMilord reviewed May 20, 2026

View reviewed changes

SimonMilord approved these changes May 20, 2026

View reviewed changes


		### Documentation Requirements

		Quantic reference docs are generated from component JSDoc. Every component class and `@api` property must be documented. See the full rules, valid categories, and code templates in Section 8 of `references/quantic-component-workflow.md`.


		## Multi-Template Components

		Components with multiple visual states override `render()`:

		Before marking any task as complete, verify every applicable item and output this table:


		\| Check \| Status \|

Conversation

mmitiche commented May 19, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

What's next

Uh oh!

changeset-bot Bot commented May 19, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

⚠️ No Changeset found

Uh oh!

svcsnykcoveo commented May 19, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Snyk checks have passed. No issues have been found so far.

Uh oh!

chromatic-com Bot commented May 19, 2026

Testing in progress…

Uh oh!

chromatic-com Bot commented May 19, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

All tests passed and all changes approved!

Uh oh!

pkg-pr-new Bot commented May 19, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions Bot commented May 19, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

erocheleau left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

SimonMilord left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

mmitiche commented May 19, 2026 •

edited

Loading

changeset-bot Bot commented May 19, 2026 •

edited

Loading

svcsnykcoveo commented May 19, 2026 •

edited

Loading

chromatic-com Bot commented May 19, 2026 •

edited

Loading

pkg-pr-new Bot commented May 19, 2026 •

edited

Loading

github-actions Bot commented May 19, 2026 •

edited

Loading