Projet

Général

Profil

Actions

Demande #4353

fermé

Établir des conventions pour le nommage des commits dans la forge April

Ajouté par Isabella Vanni il y a plus de 4 ans. Mis à jour il y a plus de 3 ans.

Statut:
Rejeté
Priorité:
Normale
Assigné à:
Christian P. Momon
Catégorie:
-
Version cible:
Début:
24/03/2020
Echéance:
% réalisé:

0%

Temps estimé:
Difficulté:
2 Facile

Description

Dans https://forge.april.org/sensibilisation/Jeu-du-Gnou, j'ai été perturbée par la mention « Ajouter source du plateau », qui ressemble plus à une tâche à faire qu'à une action effectuée.
François recommande l'utilisation de conventions pour le nommage des commits : (14:19:41) PoluX: ça permet d'éviter de perturber les gens qui les lisent.
On peut peut-être faire une page wiki pour ça ?

Perso, j'aime bien ce qui est fait dans https://forge.cliss21.org : commande en anglais, suivi par l'explication en français de ce que la commande fait.
(14:19:02) PoluX: concernant les commits, perso je suis cette convention : https://buzut.net/git-bien-nommer-ses-commits/

Mis à jour par Christian P. Momon il y a plus de 4 ans

Pour l'endroit, j'ai commencé une FAQ là : https://forge.april.org/adminsys/forge.april.org-faq
Les conseils de nommage pour l'intégrer.
Mais l'organisation « adminsys » n'est peut-être pas la meilleur pour ce dépôt. Donc on peut le déplacer.

Mis à jour par Christian P. Momon il y a plus de 4 ans

Quelques précautions :
  • attention à ne pas trop contraindre les utilisateurs :
    • des règles trop contraignantes peuvent freiner la participations des utilisateurs,
  • la convention Angular présentée sur le site buzin présente de nombreux inconvénients :
    • mélange de deux langues,
    • le préfixe n'est vraiment utile que pour les très gros projets avec plein de modules,
    • super technique alors que :
      • le commentaire est censé être une phrase,
      • difficilement compréhensible par les utilisateurs/visiteurs non techniques,
  • en général, les conventions se font projet par projet, mais c'est très bien d'en proposer une par défaut \o/
  • il est certain qu'il faut communiquer et encourager à avoir de beaux commentaires de commits <3

Mis à jour par Christian P. Momon il y a plus de 4 ans

Recommandations alternatives :
  • un commentaire de commit est une phrase courte :
    • commencer par une majuscule, finir par un point,
    • ne pas dépasser x caractères (fixer le x),
  • utiliser une forme active :
    • le commentaire du commit résume l'action portée par le commit donc pas de forme infinitive,
    • pas besoin de sujet,
    • exemples :
      • Ajout d'un logo.
      • Ajoute un fichier favicon.
      • Amélioration du code dans le module gui (#1234).
      • Add stats help in !help command display (#2910).
      • Refactor onMessage code with hook management.
  • si associable à un numéro de ticket, mettre celui-ci à la fin entre parenthèses, exemple : « Blabla (#1234). »
Autres exemple de messages :

Mis à jour par Quentin Gibeaux il y a plus de 3 ans

  • Statut changé de Nouveau à Rejeté

La forge centralise des projets variés, les projets peuvent s'auto organiser pour accorder leurs violons

Actions

Formats disponibles : Atom PDF