agentleFS
drangohtdrangoht/go-training/.claude/skills/go-review/SKILL.md

go-review

Skill0 starsChanged 2 months agoMITView on GitHub

Relire du code Go selon les conventions du dépôt (docs/BEST-PRACTICES.md) — nommage, erreurs, interfaces, concurrence, tests, allocations. À utiliser après avoir terminé un exercice, ou quand l'utilisateur demande une revue, une relecture, un avis sur son code Go.

6 other projects use a version of this.

Adopted by

Most recently taken up by

Used with

Projects with it also use typescript-review and refactor.

Other files people use alongside this one.

Files found in the same public projects as a version of this one, more often than they turn up anywhere else. Each project counts once, large collections count for less, and this file's own repository is left out.
  • samsam007bSkill

    typescript-review

    TypeScript & code quality audit: strict mode, explicit types, no-any, SOLID patterns, Clean Code naming. Sources: Martin Fowler, Google Engineering Practices, Microsoft TypeScript Handbook.

    Also in 3 projects that use this

  • GitHubSkill

    refactor

    Surgical code refactoring to improve maintainability without changing behavior. Covers extracting functions, renaming variables, breaking down god functions, improving type safety, eliminating code smells, and applying design patterns. Less drastic than repo-rebuilder; use for gradual improvements.

    Also in 3 projects that use this

  • Other versions6 projects use a version of this.

    Word for word · 0

    None found.

    Edited · 0

    None found.

    Wrote their own version · 6

    1. ArangoGutierrez/claude-toolkit★ 4same name
    2. BaratovSokhibjon/skills★ 1same name
    3. TheKREATORS/my-claude-skills★ 1same name
    4. tslateman/skills★ 1same name
    5. y-miyazaki/config★ 1same name
    6. weiweimhy/agent-skills★ 0same name

    How matches are found. Word for word: the exact same text. Edited: shares passages with this file (“99% same” means 99% of its five-word phrases also appear here; 10% or more counts). Their own version: similar meaning, or, weakest, the same name. We can’t tell which project had it first. Projects are counted among the 200 most-starred candidates, and mentions are links to the repository we found, up to 50 per site, so both counts are a floor.

  • In this repository3 other files it gives its agents.

The file

Files
SKILL.md

Revue de code Go

Objectif : faire passer du code « qui marche » à du code « idiomatique ». Le vert des tests est un prérequis, pas une conclusion.

1. Outils d'abord

Ne jamais signaler à la main ce qu'un outil trouve :

gofmt -l .                 # aucune sortie attendue
go vet ./...
go test ./... 
go test -race ./...        # obligatoire dès qu'il y a une goroutine
golangci-lint run          # si installé

Lancer ces commandes avant de lire le code, et coller la sortie réelle.

2. Grille de relecture

Parcourir dans cet ordre. Pour chaque point : citer fichier.go:ligne, montrer l'avant/après, dire pourquoi.

Correction

  • Erreur ignorée (_ = err) ou perdue en chemin
  • %w oublié : errors.Is / errors.As ne retrouvent plus rien en amont
  • Comparaison err == ErrX au lieu de errors.Is
  • Slice de l'appelant mutée sans que le contrat le dise
  • Slice nil retournée là où [] est attendu (null en JSON)
  • Indice hors bornes possible, division par zéro, entier qui déborde
  • Pointeur nil retourné dans une interface error

Concurrence

  • Goroutine sans condition d'arrêt garantie
  • close par le consommateur, ou double close
  • Envoi sur channel sans select sur ctx.Done() → fuite si personne ne lit
  • wg.Add à l'intérieur de la goroutine au lieu d'avant le go
  • Accès concurrent à une map ou un champ sans verrou
  • Struct contenant un sync.Mutex copiée (récepteur valeur) — go vet le dit
  • time.Sleep là où une attente interruptible est requise

Idiomes

  • else après un return : aplatir, chemin heureux à gauche
  • Imbrication > 3 niveaux : sortir tôt
  • Nom de package utils / helpers / common
  • Bégaiement user.NewUser, acronyme Id/Url, getter GetX
  • Interface définie côté implémentation plutôt que côté consommateur
  • Interface à plus de 3 méthodes
  • any là où un paramètre de type ferait l'affaire
  • panic hors d'un helper MustXxx sur valeur codée en dur
  • Identifiant exporté sans doc comment, ou doc ne commençant pas par son nom

Tests

  • Cas limites absents : vide, nil, zéro, négatif, doublon
  • Message d'échec sans got/want
  • t.Fatal là où t.Error permettrait de voir tous les échecs (ou l'inverse)
  • Assertion sur un ordre issu d'une map sans tri
  • Test dépendant du temps réel sans marge (flaky)
  • t.Helper() manquant dans une fonction d'assertion

Performance — seulement si mesurée

  • append dans une boucle sans préallocation, taille connue
  • Concaténation += en boucle au lieu de strings.Builder
  • Conversions []byte ↔ string répétées
  • defer dans une boucle chaude

Ne jamais proposer une micro-optimisation sans benchmark à l'appui.

3. Format du retour

## Bloquant
1. `fichier.go:42` — <problème>. <pourquoi c'est faux / ce qui casse>.
   ```go
   // avant → après

À corriger

...

Suggestions

...

Ce qui est bien fait

  • <2 ou 3 points précis, pas de flatterie générique>

Trier par gravité : bloquant (bug, race, fuite) → correction (idiome, contrat) →
suggestion (style, lisibilité). Si rien n'est bloquant, le dire clairement.

Rester concret : pas plus de dix points, les plus importants d'abord. Une revue de
trente remarques n'est pas lue.

## 4. Appliquer

Ne modifier le code que si l'utilisateur le demande. Sinon, fournir les diffs et le
laisser choisir. Ne jamais toucher aux fichiers `*_test.go` d'un exercice.

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.