Skip to main content

code-quality

Use when writing or reviewing code, comments, tests, or docs.

Informations de source

Dépôt
superdesigndev/treg
Dernière activité de la source
15 octobre 2026 à 09:08
Langue détectée de SKILL.md
anglais
Étoiles
6 455
Forks
560

Options d'installation

Le prompt qui vérifie d'abord la source est sélectionné par défaut. Vous pouvez passer à une commande directe ou télécharger une copie locale.

Vérifiez les fichiers source

Lisez SKILL.md et les fichiers associés affichés par SkillsMP avant de décider de l'installer.

Affichage de SKILL.md

SKILL.md
Instructions source · Aperçu en lecture seule
name
code-quality
description
Use when writing or reviewing code, comments, tests, or docs.
metadata
{"internal":true}
# Code quality 1. **Enforce, don't instruct.** If a machine can check a rule, add the check. Apply these rules to code you change; fix old code in its own PR. 2. **Comments: none by default.** Keep one only for behavior we cannot change (vendor, platform, protocol) or a public contract. A reason worth keeping moves to a test, the docs, or the commit message. 3. **Tests must be able to fail.** Test behavior through the real entry point; if a test still passes with every dependency returning None, it is fake. Break the behavior, show the failing run, then land it. Never turn CI green by skipping, retrying, sleeping, or loosening an assertion. 4. **Docs say only what code cannot.** Keep a sentence only if, without it, the next person would change the code wrongly. Each fact once, where it belongs; when docs and code disagree, fix the doc.
Voir sur GitHub