Informations importantes pour le projet - xishec/P9 GitHub Wiki

Noms des commits

Les commits doivent être nommés selon la forme suivante:

[Initiales]: [Type de code] [Description du commit]

  • Initiales: Les initiales des membres qui ont contribué au commit
  • Type de code: D (développement), B (correction de bogue), T (tout code en lien avec les tests), R (refactoring du code) et O (autres)
  • Description du commit: Explication courte mais précise du contenu du commit (https://chris.beams.io/posts/git-commit/)

Par exemple, si Justin Trudeau corrige un bogue sur l'affichage d'un rectangle:

JT : B Fix rectangle display issue on artboard

Si Justin Trudeau et Donald Trump ont travaillé sur une nouvelle fonctionnalité qui permet de déterminer l'algorithme qu'utilise Google:

JT & DT : D Find algorithm used by Google to save people

Pull Requests

Lorsque votre code est prêt à être mergé avec la branche master sur le origin (remote), effectuez les commandes git add et git commit. Ensuite, créez une branche dans le origin avec une des commandes suivantes:

git push -u origin [BRANCH]

git push --set-upstream origin [BRANCH]

Par la suite, dirigez-vous sur le repo P9 sur Github (https://github.com/xishec/P9). Cliquez ensuite sur le message vous indiquant la possibilité de créer un Pull Request. Sur la page de création du Pull Request, nommez votre PR en suivant la convention de nommage des branches Git (expliquée à la section précédente, mais sans vos initiales et le type de commit).

[Feat/Fix] [Nom du Pull Request]

Complétez la description du commit, mettez les tags correspondants et assignez les membres de l'équipe comme reviewers pour la revue du code.

Time-Tracking

Lorsque vous commencez à travailler sur le projet, la première chose que vous devriez faire est d'ouvrir Clockify (https://clockify.me/tracker).

Assurez-vous d'être dans le workspace P9 en regardant en haut à gauche de la page juste en dessous de votre nom. Cliquez sur l'onglet Time Tracker si ce n'est déjà fait. Écrivez en une ligne la tâche sur laquelle vous allez travailler dans la section désignée et sélectionnez le projet Web app. Vous devez également ajouter les tags qui correspondent à votre tâche principale de la période de travail. Si vous travaillez sur plusieurs éléments, choisissez le tag qui convient le mieux. Cliquez sur Start pour commencer le timer. Lorsque vous arrêtez de travailler, cliquez sur Stop pour arrêter le timer.

Vous pourriez modifier les informations de votre période de travail en tout temps.