wiki:fr/commits
developer.jelix.org is not used any more and exists only for history. Post new tickets on the Github account.
developer.jelix.org n'est plus utilisée, et existe uniquement pour son historique. Postez les nouveaux tickets sur le compte github.

Dépôt Git

Les dépôts se trouvent sur https://github.com/jelix/jelix, accessible par ssh pour ceux qui ont les droits de commits.

Le dépôt contient plusieurs branches, au moins une pour chaque version stable :

  • master : développement courant de Jelix
  • jelix-1.6.x : tous les développements sur les version 1.6.x de Jelix
  • jelix-1.5.x : tous les développements sur les version 1.5.x de Jelix
  • idem pour jelix-1.4.x, jelix-1.3.x, jelix-1.2.x

Les branches jelix-1.Y.x sont des branches stables et ne contiennent que les corrections de bugs et des améliorations mineures.

Pour les branches plus anciennes, elles sont stockées dans les anciens dépôts mercurial sur bitbucket:

Ces branches ne sont plus maintenues.

Description d'un commit

Le message assigné au commit :

  • doit être écrit en anglais
  • doit être formaté en respectant la convention d'un message git :
    • une première ligne faisant office de résumé (70 caractères maxi)
    • une ligne blanche
    • une explication plus complète de ce qui est modifié. Cette explication doit aussi contenir :
      • soit le numéro de ticket du site developer.jelix.org correspondant. Ex : "ticket #123".
      • soit le numéro de issue github. Ex : "Refs #123" ou "Closes #123"
  • vous devez indiquer le nom de l'auteur du patch avec l'option -u, si vous n'êtes pas l'auteur du patch

Exemple d'un commit d'un patch fait par toto :

git commit -u "Toto" -m "Added support of multiline tags in templates

a tag can now be closed on next lines.

Closes #68987"

Règles pour les "commiteurs"

Voici quelques règles à suivre pour ceux qui ont les droits de commit dans le dépôt officiel Github. Très peu de personnes ont ce droit. Pour contribuer, il est hautement préférable de cloner et faire des pull request sur Github.

  • Le push/pull ne pourra se faire qu'après avoir eu confirmation d'un "reviewer" ("review+" dans le ticket).
  • Seules les modifications ultra mineures (genre correction d'une coquille de syntaxe) ne sont pas sujettes à la création d'un ticket, et peuvent être commitées directement (ci-possible, après confirmation d'un reviewer par IRC ou mail).

Ce qui est commité doit fonctionner ! En particulier, celui qui commit doit s'assurer dans la mesure du possible que tous les tests unitaires passent, notamment ceux concernés par le code en question.

En résumé

  • faire un update de votre dépôt local
  • appliquer le patch
  • Lancer les tests unitaires pour vérifier que tout fonctionne
  • commiter avec le message comme indiqué ci dessus (git commit)
  • pousser le/les commits sur le dépôt officiel
  • répéter les étapes précédentes pour chaque branche, si nécessaire.
  • fermer le ticket correspondant en indiquant l'url -https://github.com/jelix/jelix/ ...) du ou des changesets git, et en indiquant la branche concernée.

Sommaire

Last modified 5 years ago Last modified on Jun 16, 2014, 11:02:31 PM