writing-comments
A maintainer skill in the Astro repository on writing comments in its TypeScript and JavaScript source for future contributors who have only the code in front of them.
Was der Skill vermittelt
A maintainer skill in the Astro repository on writing comments in its TypeScript and JavaScript source for future contributors who have only the code in front of them. It separates file overviews, which explain lasting design reasons, item docs, which describe behaviour, parameters, returns and errors, and inline comments, which explain constraints and workarounds. Comments must describe the code as it is, never its history or a reviewer, and workarounds must link an issue or pull request. It bans narrating the next line, vague hedges, emojis and section banners, gives Astro's tag conventions for deprecations and TODOs, and ends with a four-question self-check where deletion is the default.
Funktionen
- Write file overviews, item docs and inline comments
- Remove comments the code already explains
- Link workarounds to issues or pull requests
- Self-check comments before finishing
Überblick
- Herausgeber
- Astro
Installation
Das Projekt dokumentiert keine Installationsschritte, die wir bestätigen konnten. Zur Anleitung des Projekts
Was enthalten ist
- evals/evals.json
MCP-Server und Skills können Code auf deinem Rechner ausführen und auf deine Daten zugreifen. Prüfe den Quellcode, bevor du etwas installierst.
Details
| Angabe | Wert | Quelle |
|---|---|---|
| Typ | Skill | |
| Tool | Schreiben und Lektorat | |
| Herausgeber | Astro | Quelle |
| Offizieller Status | In der Dokumentation nicht angegeben | |
| Braucht API-Key oder Anmeldung | In der Dokumentation nicht angegeben | |
| Enthält Skripte | Nein | Quelle |
| Plattformen | In der Dokumentation nicht angegeben | |
| KI-Clients | In der Dokumentation nicht angegeben | |
| Lizenz | NOASSERTION | Quelle |
| Preis | In der Dokumentation nicht angegeben | |
| Aktivität | Letzter Commit am 11. Nov. 202663.887 GitHub-SterneKeine Download-Daten verfügbar (nicht auf npm oder PyPI) | Quelle |
| Links | Repository Website |
Kopien dieses Skills in anderen Repositorys (1)
Ihr Text weicht von diesem Skill ab. Es kann sich um angepasste Kopien oder ältere Versionen handeln.
- writing-commentsmodem-dev/ossrules
Mehr von Astro
10 Skills
- analyze-github-action-logs (Skill)
- astro-pr-writer (Skill)
- merge (Skill)
- changeset (Skill)
- triage (Skill)
- astro-adversary-blue (Skill)
Auch zu finden unter: Schreiben und Lektorat
Quellen
- Skill-Datei (SKILL.md)github.com/withastro/astro · Belegt: Enthält Skripte, Lizenz10. Nov. 2026
- GitHub-Repositorygithub.com/withastro/astro · Belegt: Herausgeber, Aktivität11. Nov. 2026
- Ordner im Repository (writing-comments)github.com/withastro/astro · Belegt: Enthält Skripte10. Nov. 2026