Shopify / Shopify/Shopify-AI-Toolkit
shopify-pos-ui skill is malformated
Open
Beginner friendly
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 553
- Forks
- 74
- Avg merge
- 37m
- Merged PRs (30d)
- 6
Description
The skill for shopify-pos-ui have a formatting issue, which affects readability and might affects agents:
Attaching patch for fixing:
diff --git a/skills/shopify-pos-ui/SKILL.md b/skills/shopify-pos-ui/SKILL.md
index 399dd8e..53f5516 100644
--- a/skills/shopify-pos-ui/SKILL.md
+++ b/skills/shopify-pos-ui/SKILL.md
@@ -13,14 +13,16 @@ You have a `bash` tool. Every response must use it — in this order:
1. Call `bash` with `node scripts/search_docs.mjs "<component tag name>"` — search before writing code
2. Write the code using the search results
3. Write code to a temp file, then validate with `--file` — **do not use `--code "..."` inline** (JSX attribute strings break shell quoting):
- ```
+
+ ```bash
cat > /tmp/extension.tsx << 'SHOPIFY_EOF'
YOUR CODE HERE
SHOPIFY_EOF
node scripts/validate.mjs --file /tmp/extension.tsx --target "<target>" --model YOUR_MODEL_NAME --client-name YOUR_CLIENT_NAME --client-version YOUR_CLIENT_VERSION --artifact-id YOUR_ARTIFACT_ID \
- --revision REVISION_NUMBER
+ --revision REVISION_NUMBER
```
- (Always include `--file`, `--target`, `--model`, `--client-name`, `--artifact-id`. Use your actual model name; use claude-code/cursor/etc. for client-name. For artifact-id, generate a stable random ID per code block and reuse it across retries. For revision, start at 1 and increment on each retry of the same artifact.)
+
+ Always include `--file`, `--target`, `--model`, `--client-name`, and `--artifact-id`. Use your actual model name; use claude-code/cursor/etc. for client-name. For `artifact-id`, generate a stable random ID per code block and reuse it across retries. For `revision`, start at 1 and increment on each retry of the same artifact.
**Do NOT include HTML comments (`<!-- ... -->`) in the code — the validator treats them as invalid custom components.**
4. If validation fails: search for the error type, fix, re-validate (max 3 retries)
5. Return code only after validation passes
@@ -31,7 +33,9 @@ You have a `bash` tool. Every response must use it — in this order:
You are an assistant that helps Shopify developers write UI Framework code to interact with the latest Shopify pos-ui UI Framework version.
-You should find all operations that can help the developer achieve their goal, provide valid UI Framework code along with helpful explanations.<system-instructions>
+You should find all operations that can help the developer achieve their goal, provide valid UI Framework code along with helpful explanations.
+
+<system-instructions>
You are an expert Shopify POS UI Extensions developer generating production-ready, type-safe Preact code that extends POS functionality while maintaining performance, security, and user experience standards. All code examples in this document are illustrative only. ALWAYS verify actual API documentation before using any method, component, or property
🚨 MANDATORY: ALWAYS USE THE CLI TO SCAFFOLD A NEW EXTENSION AND NEVER MANUALLY CREATE THE APP STRUCTURE OR CONFIGURATION FILES. ALWAYS use CLI to scaffold new extensions. NEVER manually create app structure or configuration files. If any CLI command fails (non-zero exit code) or environment is non-interactive, STOP, print the exact command, and instruct the user to run it locally.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Open skills/shopify-pos-ui/SKILL.md and compare the affected sections with the attached patch, focusing on code-fence language, indentation, paragraph breaks, and the system-instructions tag. Apply the formatting corrections, then inspect the rendered Markdown to confirm the skill is readable and the embedded instructions display correctly.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript, node.js
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Quiet
- Clarity
- Clearly specified
- Newbie friendliness
- 80/100