Harden skill docs for Snyk/Socket audit findings#3
Harden skill docs for Snyk/Socket audit findings#3udit19199 wants to merge 1 commit intozarazhangrui:mainfrom
Conversation
There was a problem hiding this comment.
Pull request overview
Updates the skill and repository docs to address Snyk/Socket audit concerns by hardening guidance around untrusted repositories and preventing secret leakage in generated course snippets.
Changes:
- Removed/rewrote guidance that implied auto-cloning external GitHub repos; added an explicit “treat external repos as untrusted” workflow in
SKILL.md. - Replaced “verbatim snippet” guidance with “logic-faithful but redact secrets” rules and added a dedicated snippet secret-leak gotcha section.
- Added README security posture notes and attempted ASCII normalization for scanner-friendliness.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| SKILL.md | Adds untrusted-repo handling guidance; adds snippet secret redaction rules; normalizes several symbols to ASCII. |
| README.md | Adds a security note and clarifies faithful-but-safe snippet policy; updates wording/symbols for scanner-friendliness. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
| ### Walls of Text | ||
| The course looks like a textbook instead of an infographic. This happens when you write more than 2-3 sentences in a row without a visual break. Every screen must be at least 50% visual. Convert any list of 3+ items into cards, any sequence into step cards or flow diagrams, any code explanation into a code↔English translation block. | ||
| The course looks like a textbook instead of an infographic. This happens when you write more than 2-3 sentences in a row without a visual break. Every screen must be at least 50% visual. Convert any list of 3+ items into cards, any sequence into step cards or flow diagrams, any code explanation into a code<->English translation block. |
There was a problem hiding this comment.
This sentence uses code<->English without spaces around <->, which is inconsistent with other occurrences (Code <-> English) and hurts readability. Please normalize the spacing (or choose a consistent ASCII alternative) across all mentions.
| - **`references/design-system.md`** — Complete CSS custom properties, color palette, typography scale, spacing system, shadows, animations, scrollbar styling. Read this before writing any CSS. | ||
| - **`references/interactive-elements.md`** — Implementation patterns for every interactive element: drag-and-drop quizzes, multiple-choice quizzes, code↔English translations, group chat animations, message flow visualizations, architecture diagrams, pattern cards, callout boxes. Read this before building any interactive elements. | ||
| - **`references/design-system.md`** - Complete CSS custom properties, color palette, typography scale, spacing system, shadows, animations, scrollbar styling. Read this before writing any CSS. | ||
| - **`references/interactive-elements.md`** - Implementation patterns for every interactive element: drag-and-drop quizzes, multiple-choice quizzes, code<->English translations, group chat animations, message flow visualizations, architecture diagrams, pattern cards, callout boxes. Read this before building any interactive elements. |
There was a problem hiding this comment.
code<->English translations here omits spaces around <->, unlike other parts of the file/README. Normalizing to code <-> English (or similar) would keep terminology consistent and more readable.
| - **`references/interactive-elements.md`** - Implementation patterns for every interactive element: drag-and-drop quizzes, multiple-choice quizzes, code<->English translations, group chat animations, message flow visualizations, architecture diagrams, pattern cards, callout boxes. Read this before building any interactive elements. | |
| - **`references/interactive-elements.md`** - Implementation patterns for every interactive element: drag-and-drop quizzes, multiple-choice quizzes, code <-> English translations, group chat animations, message flow visualizations, architecture diagrams, pattern cards, callout boxes. Read this before building any interactive elements. |
| - A sequence of steps -> **flow diagram with arrows** or **numbered step cards** | ||
| - "Component A talks to Component B" -> **animated data flow** or **group chat visualization** | ||
| - "This file does X, that file does Y" -> **visual file tree with annotations** or **icon + one-liner badges** | ||
| - Explaining what code does -> **code<->English translation block** (not a paragraph *about* the code) |
There was a problem hiding this comment.
In this phrase, code<->English is missing spaces around <->, which is inconsistent with the nearby heading text (Code <-> English ...) and reduces readability. Consider using code <-> English (with spaces) or another ASCII-friendly wording consistently throughout the doc.
| - Explaining what code does -> **code<->English translation block** (not a paragraph *about* the code) | |
| - Explaining what code does -> **code <-> English translation block** (not a paragraph *about* the code) |
Summary
SKILL.md.Why
Changes
SKILL.mdto:README.mdto:Validation
SKILL.mdcontains no non-ASCII characters after normalization.