Travailler comme un ingénieur : Git, PRs & revue de code · Leçon 6 sur 6 · Module bonus

Des commits et PRs qu'un examinateur lira

Votre GitHub se fait défiler avant que vous ne passiez l'entretien. Les messages de commit et les descriptions de PR sont l'échantillon d'écriture que vous ne saviez pas avoir soumis.

Par Shahriyar · Mis à jour

Les messages de commit

Ligne de sujet : ce qui a changé et pourquoi, à l'impératif, sous ~70 caractères. Ajoutez un corps seulement quand le pourquoi n'est pas évident depuis le diff. Le test : un inconnu pourrait-il repérer votre commit dans git log et savoir ce qu'il a fait sans l'ouvrir ?

▸ The difference, in four commits
# reads as rushed or copied
fix
final fix
now working
solution

# reads as an engineer
Add smoke tests for guest checkout
Wait for cart total before asserting — kills the flaky pass
Extract login steps into a fixture
Document the two skipped edge cases in the README

La description de PR est le README du relecteur

Basé sur la documentation git et ce que les relecteurs font réellement défiler

Toutes les leçons de Travailler comme un ingénieur : Git, PRs & revue de code

  1. La boucle : branche, commit, PR, merge
  2. Votre premier conflit de merge
  3. Lire du code que vous n'avez pas écrit
  4. Recevoir une revue sans le prendre personnellement
  5. Donner une revue en tant que personne qualité
  6. Des commits et PRs qu'un examinateur lira