Workflow - PA-Plasma/annual-project GitHub Wiki

GIT

Branches

  • master
  • preprod
  • dev
  • feat, fix, doc etc

Checkout et merge

  • Il faut toujours checkout depuis peprod qui est la branche stable.
  • Les commits sont autorisés uniquement sur les branche de feature et dev (hotfix mineurs seulement).
  • Les merge s'effectue toujours dans le sens ci-dessous : feature > dev > preprod > master

Nomenclature

Branches

Les noms de branche de feature doivent respecter cette nomenclature :

{label}/{feature_name}

Les labels peuvent être feat, fix, doc etc. Exemple : feat/webpack

Commits

Les noms de commits doivent respecter cette nomenclature :

{feature-name}: What i do

La description des commit doit être en anglais et chaque commit doit être le plus petit et précis possible. Il vaut mieux privilégier un grand nombre de petits commits plutôt que seulement deux ou trois gros commit.

Exemple : webpack: Init webpack, webpack: Adapt webpack configuration, webpack: Fix webpack folders

Pull Request

Les nom des pull request doivent respecter cette nomenclature :

MERGE: {origin_branch_name} into {destination_branch_name}

Exemple : MERGE: feat/webpack into devel, MERGE: devel into preprod