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.
スキルの内容
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.
できること
- 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
概要
- 公開元
- Astro
- ツール
- ライティング・編集
インストール
プロジェクトのドキュメントに、確認できるインストール手順がありません。 プロジェクトの手順を見る
含まれるファイル
- evals/evals.json
MCPサーバーやスキルは、お使いのコンピューターでコードを実行したり、データを操作したりできます。インストールする前にソースを確認してください。
詳細
このスキルのほかのコピー(1件)
このスキルとは内容が異なります。手を加えたコピーか、古いバージョンの可能性があります。
- writing-commentsmodem-dev/ossrules
Astroのほかの掲載
スキル10件
- analyze-github-action-logs (スキル)
- astro-pr-writer (スキル)
- merge (スキル)
- changeset (スキル)
- triage (スキル)
- astro-adversary-blue (スキル)
こちらにも掲載: ライティング・編集
出典
- スキルファイル(SKILL.md)github.com/withastro/astro · 根拠となる項目:スクリプトを含む, ライセンス2026年11月10日
- GitHubリポジトリgithub.com/withastro/astro · 根拠となる項目:公開元, 活動状況2026年11月11日
- リポジトリ内のフォルダ(writing-comments)github.com/withastro/astro · 根拠となる項目:スクリプトを含む2026年11月10日