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

go-exercise

Skill0 starsChanged 2 months agoMITView on GitHub

Créer un nouvel exercice Go au format de ce dépôt (README + squelette + tests table-driven + solution de référence). À utiliser quand l'utilisateur demande un exercice, un kata, un entraînement sur une notion Go (channels, génériques, erreurs, interfaces...), ou demande d'ajouter un exercice au dépôt.

The file

Files
SKILL.md

Créer un exercice Go

1. Cadrer avant d'écrire

Déterminer, en posant au plus une question si c'est vraiment ambigu :

  • la notion exactement visée (une seule notion principale par exercice) ;
  • le thème d'accueil : 01-basics, 02-types, 03-errors, 04-concurrency, 05-stdlib — ou un nouveau NN-thème si aucun ne convient ;
  • le niveau : échauffement / débutant / intermédiaire / avancé.

Vérifier qu'aucun exercice existant ne couvre déjà la notion : ls exercises/*/ et lire les README.md concernés.

2. Structure imposée

exercises/<NN-thème>/<nom>/
├── README.md
├── <nom>.go
└── <nom>_test.go
solutions/<nom>/
├── <nom>.go          implémentation de référence commentée
└── <nom>_test.go     copie EXACTE du test de l'exercice

<nom> est un identifiant Go valide, en un seul mot minuscule : c'est aussi le nom du package. Le module est github.com/drangoht/go-training.

3. Le fichier de squelette <nom>.go

  • commentaire de package en première ligne, en français ;
  • toutes les signatures présentes, avec un doc comment qui commence par le nom de l'identifiant et spécifie le contrat complet : cas limites, entrée nil, valeurs de retour d'erreur, garanties d'ordre, interdiction de muter l'entrée ;
  • corps réduit à // TODO: implémenter. + un return de valeurs zéro, pour que le package compile ;
  • exception admise : si l'exercice consiste à écrire des méthodes (voir shapes), le package ne compile pas au départ — le signaler alors en tête du README.

4. Le fichier de test <nom>_test.go

C'est le contrat. Il doit être lisible comme une spécification.

  • table-driven avec map[string]struct{...} et un t.Run(name, ...) par cas ; noms de cas en français, descriptifs ("valeur vide autorisée") ;
  • messages d'échec au format stdlib : t.Errorf("Appel(%v) = %v, want %v", in, got, want) ;
  • couvrir systématiquement : cas nominal, cas limites (vide, nil, zéro, négatif), erreurs attendues (errors.Is / errors.As), et le piège de la notion ;
  • ajouter, quand la notion s'y prête :
    • un test de non-mutation de l'entrée (slices.Clone + slices.Equal),
    • un test de déterminisme si une map est parcourue,
    • un test de fuite de goroutine (runtime.NumGoroutine) pour la concurrence,
    • un Benchmark si la performance fait partie de la leçon ;
  • pas de dépendance externe : testing + stdlib uniquement, pas de testify ;
  • quand un message d'échec peut orienter, l'écrire : "— les erreurs sont-elles agrégées avec errors.Join ?".

5. Le README de l'exercice

Reprendre exactement ce gabarit (voir exercises/03-errors/parsing/README.md) :

# NN — Titre

**Niveau :** ... · **Durée :** ... min

## Objectif
Deux ou trois phrases : ce qu'on apprend, et pourquoi ça compte en vrai.

## À implémenter
Les signatures, puis le contrat sous forme de liste ou de tableau.

## Lancer
```bash
go test -v ./exercises/<NN-thème>/<nom>/

Notions

Liste des éléments de langage et de stdlib mobilisés.

<details><summary>Indice 1 — ...</summary> ... </details> (3 à 5 indices, du plus général au plus proche du code)

Pour aller plus loin

Une ou deux extensions facultatives.


Règles de rédaction :

- **les indices sont repliés** dans des `<details>` : l'apprenant choisit quand
  les ouvrir ;
- progression : indice 1 = la piste, dernier indice = quasiment le code ;
- expliquer **pourquoi** un piège est un piège, pas seulement comment l'éviter ;
- le `NN` du titre suit la numérotation globale du dépôt (voir `README.md` racine).

## 6. Solution de référence

- copier le test **à l'identique** dans `solutions/<nom>/` ;
- écrire l'implémentation idiomatique, conforme à `docs/BEST-PRACTICES.md` ;
- commenter uniquement les décisions non évidentes (« pourquoi », jamais « quoi ») ;
- ne pas optimiser prématurément : la solution doit rester lisible.

## 7. Vérifier — obligatoire avant de rendre

```bash
gofmt -l .                                          # doit ne rien afficher
go vet ./...
go test ./solutions/<nom>/                          # doit PASSER
go test ./exercises/<NN-thème>/<nom>/                # doit ÉCHOUER (état de départ)
go test -race ./solutions/<nom>/                    # si concurrence

Coller la sortie réelle. Un exercice dont la solution ne passe pas est un exercice cassé : ne pas le livrer.

8. Mettre à jour l'index

Ajouter une ligne au tableau du README.md racine (numéro, nom, thème, notions, durée). Ne pas oublier, sinon l'exercice est invisible.

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.