Conversation
|
📚 Branch Preview Links🔍 First Generation Visual Regression Test ResultsWhen a visual regression test fails (or has previously failed while working on this branch), its results can be found in the following URLs:
Deployed to Azure Blob Storage: If the changes are expected, update the |
rise-erpelding
left a comment
There was a problem hiding this comment.
These look really nice! As is appropriate for this day and age, I had AI do some analysis here and pointed out a few things it noticed. I wouldn't consider any of it blocking though, since AI would be able to get around any minor inconsistencies, and I think having something here is better than nothing.
|
|
||
| For complete Operator and Maintainer workflows, debugging, link-verification handling, script behavior details, and the testing checklist, read: | ||
|
|
||
| **CONTRIBUTOR-DOCS/01_contributor-guides/07_authoring-contributor-docs/01_ai-agent-instructions.md** |
There was a problem hiding this comment.
This doesn't have to be a decision we make here and now, but bringing up here the thought that I had before about where this 01_ai-agent-instructions.md should live. To me, this file is a skill that we had before we knew to call it a skill, and we could move its contents up into this file to keep things a bit clearer.
There was a problem hiding this comment.
Agreed! I've moved it up to this directory under reference/ai-agent-instructions.md.
When I was chatting with Cursor it brought up a good point that the original directory in CONTRIBUTOR-DOCS was a little confusing/deceiving since there were both computer/AI docs alongside human docs. I think moving it makes sense.
|
|
||
| For the exact document structure, heading levels, collapsible sections, CSS⇒SWC mapping table format (columns, status values, ordering), DOM comparison format, and output format notes, read: | ||
|
|
||
| **CONTRIBUTOR-DOCS/03_project-planning/02_workstreams/02_2nd-gen-component-migration/02_step-by-step/01_analyze-rendering-and-styling/cursor_prompt.md** |
There was a problem hiding this comment.
Same question for this as well as with 01_ai-agent-instructions, is there an appetite for moving the reusable prompt up and officially calling it a skill?
There was a problem hiding this comment.
yyyyessss doing it.
There was a problem hiding this comment.
Makes sense to me to put scripts here, but now I have a follow up question to my earlier question about moving the CONTRIBUTOR-DOCS agent instructions into skills, if we did that, should we move the update-nav.js script (and the other script there) into .cursor/ as well?
There was a problem hiding this comment.
I did this! We have a scripts and reference directory in contributor-docs-nav now.
Open for discussion the naming. 🤔
| python scripts/create_handoff.py [task-slug] | ||
| ``` | ||
|
|
||
| Example: `python scripts/create_handoff.py implementing-user-auth` |
There was a problem hiding this comment.
Should these examples specify the full path? For instance
| Example: `python scripts/create_handoff.py implementing-user-auth` | |
| Example: `python .cursor/skills/session-handoff/scripts/create_handoff.py implementing-user-auth` |
When I had agents (via Codex & Cursor) see if there was anything here that was problematic, they both flagged this. My understanding is that the skills would be applied from the repo root, not from where the skill is located, thus why the agents are flagging this as a potential issue.
I assumed that session handoff would still work fine because AI could figure this out - which is true. I tried a session handoff (which it kinda bungled because I was on your branch and not the branch I had done the rest of the stuff from the chat I asked it to create session-handoff from), and then I asked it some questions about how it did it, and it confirmed that it had to search for the scripts then run them from the full path from .cursor/.
FWIW it's also pointing out the Python version, it's running python3 - that feels less significant.
There was a problem hiding this comment.
Those should be fixed in several places in the file now!
| | `build` | Build system or CI changes | | ||
| | `chore` | Routine maintenance tasks | | ||
| | `ci` | Continuous integration configuration | | ||
| | `deps` | Dependency updates | |
There was a problem hiding this comment.
Do we ever use this deps type? (I feel like our team tends to use chore instead.)
We don't list deps in branch-naming.mdc or in .cursor/config.json.
I'm wondering if there should be a single source of truth for all the types as well? Like this skill and the branch-naming rule should both refer to the config.json instead of re-listing all the types again?
There was a problem hiding this comment.
I removed the deps, and added some more documentation around using the config.json.
|
|
||
| ```tsx | ||
| function Tabs({ tabs }) { | ||
| const [activeIndex, setActiveIndex] = useState(0); |
There was a problem hiding this comment.
How about we tweak the examples to better fit the LIT context since we’re using LIT in SWC? Right now, many examples seem to be using React.
There was a problem hiding this comment.
Let me know what you think of the new examples! Cursor rewrote them.
a131d45 to
3642b55
Compare
cdransf
left a comment
There was a problem hiding this comment.
This looks great! Just one question. ✨
| } | ||
| ``` | ||
|
|
||
| ## iOS VoiceOver |
There was a problem hiding this comment.
Should we remove the iOS/Android/native section of this skill?
|
Once ci is green I think we are good to merge |
- accessibility compliance - explain code - documentation standards - session handoff - test-driven-development
Co-authored-by: rise-erpelding <54716846+rise-erpelding@users.noreply.github.com>
Co-authored-by: rise-erpelding <54716846+rise-erpelding@users.noreply.github.com>
83cf8f2 to
5d20b9e
Compare
Description
This PR adds Cursor agent skills and refactors existing AI instructions into the rule/skill structure within the
.cursordirectory. It introduces reusable, documented skills for common workflows (accessibility, docs, commits, migration, handoff, testing) and an always-applied deep-understanding rule, and updates .cursor documentation accordingly.NOTE: not all skills have been tested. We can continue to refine these documents, however, after we've tried to use them in realistic workflows and settings.
New skills
accessibility-compliance: WCAG 2.2–oriented guidance with ARIA patterns, mobile accessibility, and reference docs (aria-patterns.md, mobile-accessibility.md, wcag-guidelines.md).ask-questions: When and how to clarify requirements before implementing.component-migration-rendering-styling: Creating rendering-and-styling migration analysis for 2nd-gen components.contributor-docs-nav: Running the CONTRIBUTOR-DOCS nav script (breadcrumbs, TOCs, link checks).conventional-commits: Writing conventional commit messages.deep-understanding: Scoping, deep read, persistent research.md, pause for review, then implement (used by the always-applied rule).documentation: Following Adobe content writing standards when writing docs.explain-code: Explaining code with diagrams and analogies.session-handoff: Creating handoff docs, resume checklists, and scripts (create_handoff.py, validate_handoff.py, list_handoffs.py, check_staleness.py) plus evals and references.test-driven-development: TDD workflow and testing anti-patterns reference.☝️ Any skills linked above were externally written/created, but may have been tweaked to fit our needs more specifically (i.e. writing to a
.cursorfolder instead of.claude)Rules and docs
.cursor/README.md: Updated to describe newer rules and the new skills (with brief descriptions and when to use each).Motivation and context
Open questions
❓ Should we also create a small section in the
.cursor/READMEor even the project's README to explain that non-Cursor users can copy therulesandskillscontents into their own local IDE-specific directory (like.vscode) so they get the rules/skills automatically as well?Related issue(s)
Author's checklist
Reviewer's checklist
Manual review test cases
Skills and rules appear in repo
.mdcfiles and skillsSKILL.mdfiles still make understandable sense to humans. (i.e. does the skill make enough sense that you understand what the agent should do?)Documentation is coherent
Additional validation
Feel free to test any of the new skills or rules! For instance...
session-handoffskill or say something to the affect of "context is getting full" or "create handoff." You should see the agent working with something like this:.cursor/handoffsdirectory. Once the agent is done, it should give you a brief summary of the handoff doc and steps for the next session/chat.