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.
O que a skill ensina
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.
O que faz
- 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
Sobre
- Publicador
- Astro
- Ferramenta
- Escrita e revisão
Instalação
O projeto não documenta passos de instalação que tenhamos conseguido confirmar. Veja as instruções do próprio projeto
O que tem dentro
- evals/evals.json
Servidores MCP e skills podem executar código no seu computador e agir sobre os seus dados. Revise o código-fonte antes de instalar.
Detalhes
| Fato | Valor | Fonte |
|---|---|---|
| Tipo | Skill | |
| Ferramenta | Escrita e revisão | |
| Publicador | Astro | fonte |
| Status oficial | Não informado na documentação | |
| Exige chave de API ou login | Não informado na documentação | |
| Inclui scripts | Não | fonte |
| Plataformas | Não informado na documentação | |
| Clientes de IA | Não informado na documentação | |
| Licença | NOASSERTION | fonte |
| Preço | Não informado na documentação | |
| Atividade | Último commit em 11 de nov. de 202663.887 estrelas no GitHubDados de download indisponíveis (não está no npm nem no PyPI) | fonte |
| Links | Repositório Site |
Outras cópias desta skill (1)
Elas têm diferenças no texto em relação a esta skill. Podem ser cópias adaptadas ou versões mais antigas.
- writing-commentsmodem-dev/ossrules
Mais de Astro
10 skills
- analyze-github-action-logs (Skill)
- astro-pr-writer (Skill)
- merge (Skill)
- changeset (Skill)
- triage (Skill)
- astro-adversary-blue (Skill)
Também listado em: Escrita e revisão
Fontes
- Arquivo da skill (SKILL.md)github.com/withastro/astro · Comprova: Inclui scripts, Licença10 de nov. de 2026
- Repositório no GitHubgithub.com/withastro/astro · Comprova: Publicador, Atividade11 de nov. de 2026
- Pasta no repositório (writing-comments)github.com/withastro/astro · Comprova: Inclui scripts10 de nov. de 2026