Modèles de validation

Apprendre à rédiger des engagements sémantiques et professionnels

Modèles de validation

Selon la documentation Conventional Commits, les validations sémantiques sont une convention simple à utiliser dans les messages de validation. Cette convention définit un ensemble de règles pour créer un historique de validation explicite, ce qui facilite la création d'outils automatisés. Ces validations vous aideront, vous et votre équipe, à comprendre plus facilement quelles modifications ont été apportées au morceau de code validé. Cette identification se fait via un mot et un emoji qui identifient si le commit validé est un changement de code, une mise à jour de package, une documentation, un changement visuel, un test...

Types de commits

Les commits sémantiques comportent les éléments structurels (types) suivants, qui informent l'intention de votre commit auprès de l'utilisateur de votre code.

✨

feat

Indique que votre extrait de code inclut une nouvelle fonctionnalité (liée à MINOR dans le versioning sémantique).

git commit -m ":sparkles: feat: adicionar autenticação de usuário"

🐛

fix

Indique que votre extrait de code validé résout un problème (correction de bug), il est lié à PATCH dans le versionnage sémantique.

git commit -m ":bug: fix: corrigir loop infinito na validação"

📚

docs

Indique que des modifications ont été apportées à la documentation, par exemple dans le fichier README de votre référentiel (n'inclut pas les modifications de code).

git commit -m ":books: docs: atualizar README com instruções"

💄

style

Indique qu'il y a eu des modifications liées au formatage du code, aux points-virgules, aux espaces, aux peluches (n'inclut pas les modifications de code).

git commit -m ":lipstick: style: corrigir formatação do código"

♻️

refactor

Fait référence aux modifications dues à la refactorisation qui n'altèrent pas les fonctionnalités, telles que les améliorations de performances dues à la révision du code.

git commit -m ":recycle: refactor: otimizar algoritmo de busca"

⚡

perf

Il sert à identifier toute modification du code liée aux performances.

git commit -m ":zap: perf: melhorar tempo de carregamento"

🧪

test

Utilisé lorsque des modifications sont apportées aux tests, qu'il s'agisse de créer, de modifier ou de supprimer des tests unitaires (n'inclut pas les modifications de code).

git commit -m ":test_tube: test: adicionar testes unitários"

🔨

build

Utilisé lorsque des modifications sont apportées pour créer des fichiers et des dépendances.

git commit -m ":package: build: atualizar dependências"

🧱

ci

Indique les changements liés à l’intégration continue.

git commit -m ":bricks: ci: configurar pipeline de deploy"

🔧

chore

Indique les mises à jour des tâches de build, des paramètres d'administration et des packages (n'inclut pas les modifications de code).

git commit -m ":wrench: chore: atualizar .gitignore"

🗃️

raw

Indique les modifications liées aux fichiers de configuration ou aux données brutes.

git commit -m ":card_file_box: raw: dados brutos do projeto"

🧹

cleanup

Indique le nettoyage du code, la suppression des commentaires inutiles et les optimisations générales.

git commit -m ":broom: cleanup: remover código não utilizado"

🗑️

remove

Indique la suppression de fichiers, de fonctionnalités ou de code qui ne sont plus nécessaires.

git commit -m ":wastebasket: remove: deletar arquivos obsoletos"

Modèles d'émoticônes

Type de validation	Émoji	Mot clé
Accessibilité	♿	:wheelchair:
Ajouter un test	✅	:white_check_mark:
Mise à jour de la version du sous-module	⬆️	:arrow_up:
Rétrograder la version du sous-module	⬇️	:arrow_down:
Ajouter une dépendance	➕	:heavy_plus_sign:
Modifications de la révision du code	👌	:ok_hand:
Animations et transitions	💫	:dizzy:
Correction d'un bug	🐛	:bug:
Commentaires	💡	:bulb:
Engagement initial	🎉	:tada:
Paramètres	🔧	:wrench:
Déployer	🚀	:rocket:
Documentation	📚	:books:
En cours	🚧	:construction:
Style de l'interface utilisateur	💄	:lipstick:
Infrastructure	🧱	:bricks:
Liste des tâches	🔜	:soon:
Déplacer/Renommer	🚚	:truck:
Nouvelle fonctionnalité	✨	:sparkles:
Package.json dans JS	📦	:package:
Performance	⚡	:zap:
Refactorisation	♻️	:recycle:
Nettoyage des codes	🧹	:broom:
Supprimer un fichier	🗑️	:wastebasket:
Supprimer une dépendance	➖	:heavy_minus_sign:
Réactivité	📱	:iphone:
Annuler les modifications	💥	:boom:
Sécurité	🔒	:lock:
Référencement	🔍	:mag:
Balise de version	🔖	:bookmark:
Réussir le test	✔️	:heavy_check_mark:
Essais	🧪	:test_tube:
Texte	📝	:pencil:
Dactylographie	🏷️	:label:
Gestion des erreurs	🥅	:goal_net:
Données	🗃️	:card_file_box:

Principales commandes Git

Dépôt de clones

Clone un référentiel GitHub distant existant dans votre environnement local.

git clone url-do-repositorio-no-github

Initialiser le référentiel

Initialise un nouveau référentiel Git dans le répertoire actuel.

git init

Ajouter des fichiers

Ajoute tous les fichiers et modifications du répertoire actuel à la zone de transit.

git add .

S'engager

Enregistre les modifications ajoutées à la zone de préparation avec un message descriptif.

git commit -m "mensagem do commit"

Renommer la branche

Renomme la branche actuelle (master) en main. -M est utilisé pour forcer le changement de nom.

git branch -M main

Ajouter un référentiel distant

Ajoute un référentiel distant appelé origin au référentiel local.

git remote add origin https://github.com/usuario/nome-do-repositorio.git

Envoyer au référentiel

Envoie les validations de la branche locale au référentiel distant.

git push -u origin main

Mise à jour depuis le référentiel

Met à jour la branche locale avec les modifications du référentiel distant.

git pull origin main

Connecter le référentiel local

Lorsque vous disposez déjà d'un référentiel local et que vous souhaitez le connecter à un référentiel distant sur GitHub.

git remote add origin git@github.com:usuario/projeto.git
git branch -M main
git push -u origin main

Récupérer les mises à jour

Récupère toutes les mises à jour du référentiel distant sans les fusionner dans la branche actuelle.

git fetch

Poussée forcée en toute sécurité

Un moyen plus sûr de forcer le transfert des modifications locales vers le référentiel distant.

git push --force-with-lease

Annuler la validation

Crée un nouveau commit qui annule les modifications apportées par le commit spécifié.

git revert id_do_commit_que_vai_ser_revertido

Réinitialiser la validation

Réinitialise le référentiel à l'état de validation spécifié, en supprimant toutes les modifications ultérieures.

git reset --hard id_do_commit_anterior_ao_que_vai_ser_apagado

Modifier le message de validation

Modifie le message du dernier commit.

git commit --amend -m "mensagem_reescrita"

Choix de cerises

Utilisé pour récupérer un commit spécifique d'une autre branche.

git cherry-pick HASH_DO_COMMIT

Changer de branche

Basculez vers une autre branche dans le référentiel local.

git switch <branch>

Glossaire

fork

Copiez un référentiel sur votre propre compte GitHub.

issues

Outil utilisé pour gérer les tâches et les corrections de bugs.

pull request

Mécanisme utilisé pour soumettre les modifications proposées au référentiel d'origine.

gist

Outil de partage d'extraits de code.

💡Conseils importants

✓Utilisez des messages clairs et descriptifs expliquant ce qui a été modifié
✓Gardez les commits petits et concentrés sur une seule fonctionnalité
✓Utilisez le type de commit correct pour faciliter la navigation dans l'historique
✓Testez toujours vos modifications avant de les valider

Modèles de validation