CONTRIBUTING.md

Guide de contribution Trouver une Fresque (web)

Bonjour ! Bienvenue sur le dépôt de code de l'application web Trouver une Fresque.

C'est ici que se développent les prochaines fonctionnalités à ajouter au front et tu as peut-être envie de participer à l'aventure. Nous accueillons ta contribution avec plaisir et ce document est là pour faciliter ton intégration au sein du projet VMD.

Mais d'abord, quelques indications sur ce que contient ce dépôt :

• l'application web type SPA développée avec des composants lit-elements, lit-html et compilée avec vite
• Les ressources (images, logo, etc.) qui sont utilisées exclusivement par cette application
• Le contenu SEO en relation avec Trouver une Fresque.

D'autres dépôts participent au fonctionnement de Trouver une Fresque :

• trouver-une-fresque/trouver-une-fresque : Le scrapper qui récupère et agrège les données
• trouver-une-fresque/trouver-une-fresque-android : L'application Android

Proposer une implémentation de fonctionnalité

Nous fonctionnons par Pull Requests. Rien de bien exceptionnel mais voici les quelques points importants :

• Avant de commencer à coder, clone le dépôt, en particulier la branche dev
• Crée une nouvelle branche à partir de cette branche dev
• Ajoute la nouvelle fonctionnalité ou corrige le bug. Les tests et les petits commits réguliers sont très encouragés.
• Si tu cherches à résoudre une issue, pense à indiquer son numéro dans le message de commit
• Pousse ta branche sur github
• Ouvre une merge request qui cible la branche dev
• Assure-toi que tout est vert sur l'interface !

Mettre en prod

Regulièrement, nous mettons en prod le code prêt qui se trouve sur la branche dev. Pour faire ceci :

• Prépare une Release Note. Le plus facile est de s'inspirer de la précédente

• Cible la branche main avec un nom de tag qui comprend la date du jour au format YYYYMMDD.

• Enregistre en brouillon et demande une revue !

• Localement, merge dev dans main avec ces commandes:

  • git fetch --prune
  • git checkout main
  • git reset --hard origin/main
  • git pull --merge origin dev
  • git push origin main

• Publie la relase note ! Le tag git sera ajouté directement depuis Github.

Outils pour la rédaction de la release note

Lister les commits depuis la dernière release

git log --oneline <précédente release>..dev --graph

Trouver les numéros des Pull Request mergées depuis la dernière release

git log --oneline <précédente release>..dev | grep 'Merge pull request'

Trouver les noms des contributeurs (de code)

git shortlog <précédente release>..dev