Skip to content

Convention commit #1

@amrosu

Description

@amrosu

Objectif

Mise en place d'une convention partagée des commits pour les versions publiées ("releases")

Démarche

Une proposition : la convention angular semble bien adaptée à notre besoin (pour plus de détails, voir https://github.com/angular/angular/blob/master/CONTRIBUTING.md#commit).

Pour un commit :
<type>(<scope>): <short summary>

où :
Type

  • élément obligatoire
  • doit prendre une de ces valeurs : build|ci|docs|feat|fix|perf|refactor|test
    (ci = "continuous integration")

Scope

  • élément optionnel ;
  • dans un premier temps, notre liste peut se contenter d'un seul élément (mask) et on ajoutera d'autres plus tard, en fonction des évolutions du code

Summary

  • élément obligatoire
  • message clair et court, en anglais (lors de la révision d'une PR, il faudrait accorder une attention particulière à la correction et à la traduction des messages si nécessaire)

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions