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.
What the skill teaches
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.
Capabilities
- 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
About
- Publisher
- Astro
Install
The project doesn't document install steps that we could confirm. See the project's own instructions
What's inside
- evals/evals.json
MCP servers and skills can run code on your computer and act on your data. Review the source before installing.
Details
| Fact | Value | Source |
|---|---|---|
| Type | Skill | |
| Tool | Writing and editing | |
| Publisher | Astro | source |
| Official status | Not stated in its documentation | |
| Needs an API key or sign-in | Not stated in its documentation | |
| Includes scripts | No | source |
| Platforms | Not stated in its documentation | |
| AI clients | Not stated in its documentation | |
| Licence | NOASSERTION | source |
| Pricing | Not stated in its documentation | |
| Activity | Last commit Nov 11, 202663,887 GitHub starsDownload data not available (not on npm or PyPI) | source |
| Links | Repository Website |
Copies of this skill in other repositories (1)
These differ from this skill's text. They may be adapted copies or older versions.
- writing-commentsmodem-dev/ossrules
More from Astro
10 skills
- analyze-github-action-logs (Skill)
- astro-pr-writer (Skill)
- merge (Skill)
- changeset (Skill)
- triage (Skill)
- astro-adversary-blue (Skill)
Also listed under: Writing and editing
Sources
- Skill file (SKILL.md)github.com/withastro/astro · Backs: Includes scripts, LicenceNov 10, 2026
- GitHub repositorygithub.com/withastro/astro · Backs: Publisher, ActivityNov 11, 2026
- Folder in the repository (writing-comments)github.com/withastro/astro · Backs: Includes scriptsNov 10, 2026