diff --git a/Contributor/En/Guide.xyl b/Contributor/En/Guide.xyl index a9615f0..6d6eb14 100644 --- a/Contributor/En/Guide.xyl +++ b/Contributor/En/Guide.xyl @@ -392,6 +392,40 @@ $ git commit
Do not edit the CHANGELOG.md
file. It is automatically
generated.
Has we already seen in the previous section, a commit title must be less + than 50 characters long. This title must be precise and reading it must allow + to identify the corresponding modifications.
+ +To facilitate the writing of this title, we defined a structure:
+ type(scope) title
+ +
This structure allow to describe very easily which kind of commit is it and + on which part. We have indeed isolated several recurring types in a + project:
+ +feat
for a new feature,fix
for a bug fix,test
for a test modification,doc
for a documentation modification,chore
to replace the “Quality” type.For example, we can obtain:
+ +feat(permission) Search backward bla bla.,
fix(user) `getName` is incorrectly computing its value.,
…
The goal is to generate a CHANGELOG
file as suggested by
+ http://keepachangelog.com/fr/1.0.0/,
+ so with the “Added”, “Bug fixes”, “Removed“ Sections, and the date of the
+ release.
Sometimes you will express the need to list all your diff --git a/Contributor/Fr/Guide.xyl b/Contributor/Fr/Guide.xyl index 28e4450..dd56e04 100644 --- a/Contributor/Fr/Guide.xyl +++ b/Contributor/Fr/Guide.xyl @@ -425,6 +425,41 @@ $ git commit
Ne modifiez pas le fichier CHANGELOG.md
. Il est
généré automatiquement.
Comme nous l'avons vu précédemment, le titre d'un commit fait 50 caractères + au maximum. Ce titre se doit d'être précis et sa lecture + doit permettre d'identifier la modification apportée.
+ +Pour faciliter l'écriture de ce titre, nous avons définit une structure
+ type : type(scope) title
+ +
Cette structure permet de très facilement décrire quel est le type de + commit et sur quoi il porte. Nous avons en effet isolé plusieurs types + récurents dans un projet :
+ +feat
pour une nouvelle fonctionnalité,fix
pour un correctif,test
pour une modification liée aux tests,doc
pour tout ce qui se rapporte à la documentation,chore
pour tout ce qui concerne la « qualité ».Nous obtenons par exemple :
+ +feat(permission) Search backward bla bla.,
fix(user) `getName` is incorrectly computing its value.,
…
L'objectif de la normalisation des messages de commit est de permettre la
+ génération d'un fichier CHANGELOG
tel que suggéré sur
+ http://keepachangelog.com/fr/1.0.0/,
+ avec des sections « Ajouts », « Correctifs », « Suppressions » ainsi que la date
+ de la sortie de version.
Parfois vous pourrez exprimer le besoin de lister tous vos