editing
Installation
SKILL.md
Editing Files
-
Comments start with a lowercase letter:
// unmount svelte components... -
No trailing period on bullet points or incomplete sentences (headers, fragments, single-noun-phrase comments). e.g.
- open /maplibre?debugnot- open /maplibre?debug.;// close event listenernot// close event listener. -
No space between number and unit:
30snot30 s. -
Lengthy and important comments belong in
/** */blocks, not in stacked//lines. Use//for short single-line comments and inline notes. Anything that explains a non-obvious invariant, a multi-step rationale, or warns about a foot-gun goes in a JSDoc-style block so it stands out and IDEs/tooling render it. Place the block directly above the construct it describes (function, method, branch, or key statement).// ❌ BAD: stacked // lines for a multi-paragraph rationale // programmatic closes (showPopup, closePopup) reassign or clear // activePopup before remove(), so the comparison fails for those // and the listener returns. user-initiated closes still match. popup.on('close', () => { ... })