Spécification commitizen git soumis conventionnel changelog-cli

I. introduction

Code de spécification des changements de code soumis peuvent ainsi enregistrer le journal, la spécification du journal soumis au rollback problème de positionnement ou un code d'une grande importance.

 

En second lieu, l'utilisation de plug-in liste

• commitizen
• cz-conventionnel changelog
• conventionnel changelog-cli

 

1. Code de spécification commitizen Soumettre

 

1.1 Adresse de l'entrepôt NPM

https://www.npmjs.com/package/commitizen

 

fiche Commitizen Description: Lors de l' utilisation Commitizen soumis, vous serez invité à remplir tous les champs nécessaires pour présenter au moment de la soumission . Vous n'avez pas besoin d'attendre plus tard git commit fonction de crochet pour détecter et refuser de se soumettre votre demande de contenu soumettre.

 

1.2

 

1.2.1 installer le plug commitizen 

NPM installer commitizen -D

 

1.2.2 cz-conventionnel changelog

cz-conventionnel changelog de soumettre la spécification de l'information.

NPM installer cz-conventionnel changelog -D

 

1,3 package.json Configuration

"config" : {
     "commitizen" : {
       "chemin": "./node_modules/cz-conventional-changelog" 
    } 
  }

 

Ajouter une instruction, comme le commettras, en se référant à la configuration comme indiqué ci-dessous:

 

 

 

1.4 description

Lorsque vous exécutez run NPM commit, apparaissent les options d'interaction:

 

(1) Type

 

 Description:

• exploit: une nouvelle fonctionnalité
• fix: bug fix
• docs: modifier uniquement la documentation, comme README, CHANGELOG, CONTRIBUER etc.
• style: il suffit de modifier l'espace, tirets, etc. format sans changer la logique de code
• refactor: refactorisation de code, ne pas ajouter de nouvelles fonctionnalités ou des corrections de bugs
• perf: optimisation liées, telles que l'amélioration de la performance, l'expérience
• Test: cas de test, y compris des cas de test augmenté par la correction ou la suppression Exemple

 

(2) quel est le scope de ce changement? 

Cette modification affecte le contenu (plage)? Vous pouvez remplir le nom du fichier

(3) une courte introduction

(4) l'introduction d'un long

(5) si cette modification pour parvenir à un certains problèmes?

Plus de captures d'écrans interactifs:

 

2, engagent générés classiques-changelog-cli log

conventionnel changelog-cli: générer des changements journaux à partir des métadonnées de git.

 

2.1

2.1.1 Installation

NPM installer -S conventionnel changelog-cli

 

2.1.2 Nouveau CHANGELOG.md dans le répertoire racine du projet

 

2.1.3 package.json ajouter des instructions

"Genlog": "angulaire conventionnel changelog -p -i -s CHANGELOG.md"

Tels que:

 

 2.1.4 Générer un journal

NPM course Genlog

conventionnel changelog-cli ne peut écraser un journal des modifications précédent. Le nouveau journal basé sur une validation de la « Feature », « Fix », « amélioration de la performance » ou « Les modifications récentes » ..

 

2.1.5 La mise en œuvre initiale

Si ceci est votre première fois à l'aide de cet outil, et que vous voulez générer tout le journal précédent du changement, vous pouvez effectuer:

conventionnel changelog -p angulaire -i -s -r 0 CHANGELOG.md

 

2.1.6 fichier journal Exemple