Difference between revisions of "Commit Guidelines/fr"

Latest revision as of 14:09, 6 November 2015

Other languages:

English • ‎español • ‎français

Le guide pratique pour les 'Commit' pour le CMS Joomla.

Ces lignes directrices ne sont pas des règles rigides, mais se veulent plutôt un guide de ce que nous considérons comme les meilleures pratiques.

Merge-Commit Vs. Squashing (Fusion-validation contre Écrasement)

Fusion-validation (Merge-Commit)

Lorsque vous cliquez sur le bouton "Merge" de GitHub, cela va créer un merge-commit nommé "Merge pull request #1234 from User/Branch". Ce commit apparaîtra alors avec l'ensemble des autres dans le journal des PR. Chaque commit présentera une date unique, à laquelle il a été créé et non pas celle où il a été validé (merged).

Écraser (Squashing)

Lorsque vous écraser les commits, vous créez un commit unique composé de l'ensemble des commits originaux. Ce commit unique est alors poussé au Master et peut être nommé de façon standardisée.

Recommandation

Dans la plupart des cas, nous d'écraser les commits. Le bouton "Merge" de GitHub devraient uniquement être utilisé pour des PR simples avec quelques commits et datant de quelques jours. C'est notamment les cas pour des PR simples traitant de styles ou des chaînes de langue.

Les conventions de nommage

Lors de l'écrasement de commits, il vous faut suivre des conventions de nommage afin de faciliter la lecture du journal.

Format

<[Prefix]> <Title>. <Issue>

<Description>

Préfixes

Préfixe	Signification
sec	Sécurité
bug	Correctif d'anomalie
add	Ajouter
rem	Supprimer
lang	Langue
doc	Documentation / Notes
imp	Amélioration
tests	Tests

Un commit peut avoir plusieurs préfixes. Si c'est le cas, chacun sera placé dans ses propres brackets.

Titre

Utilisez un titre descriptif pour le commit. Généralement, le titre du PR conviendra parfaitement.

Anomalie

Après le titre, il convient d'ajouter un point suivi d'un texte comme "Closes #1234". Cela va automatiquement fermer le PR lorsque le commit sera appliqué et fournira également un lien vers le PR. Pour connaitre les mots clés disponibles, veuillez consulter : https://help.github.com/articles/closing-issues-via-commit-messages.

Description

La description est facultative. Elle peut contenir des informations supplémentaires au commit. Habituellement, ceci n'est pas nécessaire puisque les informations sont disponibles dans le rapport du PullRequest.

Exemple

[lng] Clarify content smart search plugins. Closes #1833

@@ Line 1: / Line 1: @@
 <noinclude><languages /></noinclude>
-Commit Guidelines for the Joomla! CMS.
+Le guide pratique pour les 'Commit' pour le CMS Joomla.
-These guidelines are not meant to be strict rules, but a guide for what we consider best practice.
+Ces lignes directrices ne sont pas des règles rigides, mais se veulent plutôt un guide de ce que nous considérons comme les meilleures pratiques.
-== Merge-Commit vs Squashing ==
+== Merge-Commit Vs. Squashing (Fusion-validation contre Écrasement) ==
-=== Merge-Commit ===
+=== Fusion-validation (Merge-Commit) ===
-When you click the “Merge” button on GitHub, it will create a merge-commit named “Merge pull request #1234 from User/Branch”. This commit will show together with all commits in the PR in the log. Each commit will have the original date when it was created, not when it was actually merged. While this is nice to preserve the actual commit history and is fine with Git Clients which show the branches, it becomes unreadable especially on the GitHub log page.
+Lorsque vous cliquez sur le bouton "Merge" de GitHub, cela va créer un merge-commit nommé "Merge pull request #1234 from User/Branch". Ce commit apparaîtra alors avec l'ensemble des autres dans le journal des PR. Chaque commit présentera une date unique, à laquelle il a été créé et non pas celle où il a été validé (merged).
 === Écraser (Squashing)===
-When you squash the commits, you create a single commit consisting of all original commits. This single commit is then pushed to master and can be named in a standardised way.
+Lorsque vous écraser les commits, vous créez un commit unique composé de l'ensemble des commits originaux. Ce commit unique est alors poussé au Master et peut être nommé de façon standardisée.
 === Recommandation ===
-We recommend to squash the commits in most cases. The “Merge” button in GitHub should only be used for simple PRs with only a few commits and when it’s only a few days old. Most of time, this is the case for simple PRs dealing with codestyle or language strings.
+Dans la plupart des cas, nous d'écraser les commits. Le bouton "Merge" de GitHub devraient uniquement être utilisé pour des PR simples avec quelques commits et datant de quelques jours. C'est notamment les cas pour des PR simples traitant de styles ou des chaînes de langue.
-== Naming Conventions ==
+== Les conventions de nommage ==
-When squashing commits, one should follow these naming conventions so the log will become easier to read.
+Lors de l'écrasement de commits, il vous faut suivre des conventions de nommage afin de faciliter la lecture du journal.
 === Format ===
@@ Line 43: / Line 43: @@
 |-
 |lang
-|Language
+|Langue
 |-
 |doc
@@ Line 49: / Line 49: @@
 |-
 |imp
-|Improvement
+|Amélioration
+|-
+|tests
+|Tests
 |}
-A commit may have multiple prefixes. If that’s the case, each goes into its own brackets.
+Un commit peut avoir plusieurs préfixes. Si c'est le cas, chacun sera placé dans ses propres brackets.
 === Titre ===
-Use a descriptive title for the commit. Usually the title of the PR will be fine.
+Utilisez un titre descriptif pour le commit. Généralement, le titre du PR conviendra parfaitement.
 === Anomalie ===
-After the title we add a dot, followed by a text like “Closes #1234”. This will automatically close the PR when the commit is pushed to staging and also provides a link to the PR. See https://help.github.com/articles/closing-issues-via-commit-messages for the available keywords.
+Après le titre, il convient d'ajouter un point suivi d'un texte comme "Closes #1234". Cela va automatiquement fermer le PR lorsque le commit sera appliqué et fournira également un lien vers le PR. Pour connaitre les mots clés disponibles, veuillez consulter : https://help.github.com/articles/closing-issues-via-commit-messages.
 === Description ===
-The description is optional. It can contain additional information to the commit. Usually that is not needed as the information is available in the linked Pull Request.
+La description est facultative. Elle peut contenir des informations supplémentaires au commit. Habituellement, ceci n'est pas nécessaire puisque les informations sont disponibles dans le rapport du PullRequest.
 === Exemple ===

Joomla