web-dev-qa-db-fra.com

Comment puis-je contribuer du code à Joomla?

Je suis conscient du fait que le code est géré à https://github.com/joomla/joomla-cms (pour le CMS au moins) et que je devrais soumettre des demandes d'extraction suggérant l'ajout de code.

Je suis particulièrement intéressé par tous les bons conseils pour gérer mes contributions et m'assurer que le code entre au bon endroit.

Devrais-je utiliser différentes branches dans mon dépôt forked pour gérer différentes contributions? Si tel est le cas, quel est le meilleur moyen de relier cette branche aux branches principales du référentiel Joomla?

Y at-il une bonne méthode pour garder ma copie forkée à jour?

Toute suggestion sur un bon flux pour gérer ce processus serait vraiment utile!

19
David Fritsch

Il est toujours bon d'avoir une branche dédiée pour chaque demande d'extraction que vous allez faire.

L'un des moyens les plus simples de créer une nouvelle branche mise à jour consiste à utiliser simplement l'interface graphique Web GitHub pour modifier le fichier dans le référentiel d'origine. Lors de la sauvegarde, GitHub créera automatiquement une nouvelle branche dans votre fourche en fonction de la branche en cours de modification. Si vous souhaitez éditer plus de fichiers, vous pouvez les éditer dans votre branche nouvellement créée et à jour.

Si vous connaissez un peu Git, vous devez alors baser votre branche intermédiaire intermédiaire avec la branche d'origine en amont afin qu'elle soit synchronisée avant de créer de nouvelles branches. De plus, si vous devez mettre à jour un PR, il est recommandé de le rebaser au lieu de fusionner le maître. Bien que les deux méthodes fonctionnent, les fusions par fusion ne font que créer une mauvaise histoire et sont plus difficiles à écraser.

De manière générale, les PN devraient être "atomiques". Cela signifie que si vous essayez de réparer quelque chose, ne corrigez que ce bogue particulier. Ne corrigez pas deux bogues différents dans le même PR et ne corrigez pas non plus le style de code. Il est plus facile de tester et aussi moins de créer des conflits si le PR vit un peu plus longtemps que prévu.

Et bien sûr, ajoutez une bonne description de ce que vous voulez faire et des instructions de test pour reproduire le problème et tester votre correctif :-)

10
Bakual

Une grande chose qui aide à regrouper vos contributions est de déplacer chaque contribution dans une branche distincte, nommée de manière appropriée. Si vous ajoutez une fonctionnalité, utilisez un préfixe tel que feature- et ajoutez une ou deux descriptions de fonctionnalité Word pour le nom de la branche. S'il s'agit d'un correctif dans la classe JForm, utilisez bugfix-jform. Cela rend vraiment facile à identifier ce que vous travaillez en vérifiant vos branches git via git branch -a.

4
Don Gilbert