Les pull requests

Sokkin utilise le processus de “pull requests” commun à de nombreux projets utilisant git. Ce processus devrait être familier aux contributeurs expérimentés de logiciels libres. L’idée est qu’un petit nombre de personne ait accés à la branche principale (communément appelée “master”).

Pour ce faire, les contributeurs développent leurs fonctionnalités de la façon suivante:

../_images/pr.png
  1. Le développeur copie ou clone le dépot, puis crée une branche dédiée.
  2. Le développeur crée une fonctionnalité sur le dépot local sur la branche dédiée.
  3. Le développeur crée une pull request via l’interface GitLab.
  4. Le reste de l’équipe procède à la relecture du code puis valide ou non la pull request.
  5. Si la pull request est validée, le chef de projet procède à l’envois du code sur la branche principale.

Les branches

Chez Sokkin, nous utilisons les branches suivantes:

../_images/branches.png

  • Master: C’est la branche d’origine. Elle permet uniquement la création d’autres branches, et l’ajout de code via Merge Request

  • Release: La branche release est la source des branches de développement. Elle permet de tester les fonctionnalitées avant de les ajouter sur la branche Master .

  • Feature-X-NAME: Les branches de features sont crées par les développeurs, leur nom devra suivre la règle suivante: FEATURE-<nom_de_la_fonctionnalité>-<nom_du_developpeur>

    Par exemple: Feature-UserAccount-John_d

  • Bug: Les branches de bug permettent de corriger une fonctionnalité ajoutée à une des deux branches réservés. (Master ou Release).

Tester son code

Le projet sokkin se base sur une méthodologie d’intégration continue. A chaque ajout de nouvelles fonctionalités, des séries de tests sont appliqués sur l’ensemble du projet.

Nous distinguons trois types de tests.

Types de tests
Type de test Definition
Tests unitaires Valider l’execution d’une partie précise.
Tests de non régression Empecher les effets de bord.
Tests d’intégration Valider l’ensemble des parties.

Les tests unitaires sont sous la responsabilité du développeur lorsqu’il ajoute une nouvelle fonctionnalité.

Tests unitaires

Sokkin se base sur le framework jest pour la création de tests unitaires. Voir Installer son environnement de développement pour l’installation de jest.

Note

Pour plus d’information sur jest veuillez vous referer à la documentation officielle: https://jestjs.io/docs/en/getting-started

L’execution des tests unitaires se fais via la commande

npm run unittest

Les fichiers de tests sont dans le dossier ~/__tests__