search

Kylian2 / jo-application

Dépot Git du projet SAE-1256. Projet Réalisé à l'IUT d'Orsay.
0 stars 0 forks source link

readme

SAE 1256

Présentation

Voici la réalisation de notre équipe pour le projet SAE1256, réalisé à l'IUT d'Orsay en 2024. Le projet consistait à développer une application de gestion des Jeux Olympiques en Java. Ce projet était commun à plusieurs matières : DOO (Développement Orienté Objet), IHM (Interaction Homme-Machine) et GPI (Gestion de Projet Informatique). Ceci est le rendu DOO.

Membres de l'équipe

Conventions et règles

1. Normalisation

Les Couleurs

Couleurs Utilisées dans le Projet

Ce projet utilise une palette de couleurs spécifique, chacune étant définie par des valeurs RGB. Ces couleurs sont utilisées pour différents éléments de l'interface utilisateur afin de garantir une expérience visuelle cohérente et attrayante. Les couleurs sont issues de la Charte Graphique des Jeux Olympiques et Paralympiques de Paris 2024. Voici les différentes couleurs et leurs représentations :

BLEU_JO

JAUNE_JO

VERT_JO

ROUGE_JO

COULEUR_FOND_JO

OR

ARGENT

BRONZE

2. Convention de commit

Nous suivons la convention de commit suivante : Convention.

Voici quelques points clés de cette convention :

Structure du message de commit

Un message de commit se compose de trois parties :

  1. En-tête (header)
  2. Corps (body)
  3. Pied de page (footer)
<type>(étendue optionnelle): <description>
[corps optionnel]
[pied optionnel]

En-tête (Header)

L'en-tête est obligatoire et doit être concis. Il se compose de :

Voici quelques exemples de types :

Exemples :

Corps (Body)

Le corps est optionnel mais recommandé pour les commits complexes. Il fournit une description détaillée des modifications, raisons et contexte.

Pied de page (Footer)

Le pied de page est optionnel et est utilisé pour des informations supplémentaires comme les références aux tickets (issues) ou les notes spéciales.

Exemple de commit avec en-tête, corps et pieds de page : 

fix: corriger le bug d'affichage sur la page d'accueil

Ce correctif résout un problème où les images ne s'affichaient pas correctement sur la page d'accueil. La cause était une mauvaise URL d'image générée par la fonction de rendu

Reviewed-by: Zanzibar35
Refs: #123

Utilisation de GitHub

1. Récuperer le travail

Pour récuperer pour la première fois le travail, il faut cloner le dépot sur sa machine. 

git clone https://github.com/Kylian2/jo-application.git

2. Créer sa branche de travail

Pour travailler de façon organiser et en évitant le plus possible les conflits, il faut créer une branche de travail. 

git checkout -b <nom_de_la_branche>

3. Travailler sur une branche

La branche sera utilisé tout au long de l'implémentation de la fonctionnalité sur laquelle vous travaillez. Pendant ce temps, vous pouvez faire des modifications et les ajouter.

Pour ajouter les modifications : 

git add .
git commit -m 'mon_message_qui_suit_la_convention'

4. Pousser les modifications

Après avoir fait le commit, vous pouvez partager à tout les membres vos modifications, pour cela il faut faire : 

git push origin <nom_de_la_branche>

Cette commande à exactement le même effet que :

git push

sauf que c'est plus clair pour git, puisqu'il sait sur quelle branche envoyer les modifications.

Voilà ce qu'il se passe :

5. Créer une Pull Request

Quand tout le travail à faire sur cette fonctionnalité a été fait, vous pouvez créer une Pull Request. La Pull Request permet d'amorcer le processus pour integrer les modifications de la branche dans la branche principale.

Pour créer une Pull Request, il faut :

6. Revoir et fusionner la Pull Request

Les membres de l'équipes peuvent revoir le code, poser des questions, demander des modifications...

Ensuite quand tout le monde est d'accord, vous pouvez fusionner la Pull Request en cliquant sur Merge pull request.

Si il y a des conflits resolvez les.

Et puis tout est prêt !

Le mieux est ensuite de supprimer la branche de travail que l'on vient de fusionner. Pour cela il y a un bouton qui apparaitra une fois la Pull Request terminée. Sinon : 

git push origin --delete <nom_de_la_branche>

7. Mettre à jour la branche principale pour tout les membres.

Après la fusion de la PR, chaque membre de l'équipe doit mettre à jour sa branche principale locale (la branche main sur sa machine) : 

git checkout main
git pull origin main

Dans le cas où vous n'avez pas supprimé la branche de travail, il faudra la mettre à jour également en fusionnant avec la branche principale :

git checkout <nom_de_la_branche>
git merge main

Si des conflits surviennent, il faudra les resoudre manuellement. Dans les fichiers en conflits, il seront indiqués dans le code par les symboles <<<<<<, ======, et >>>>>>.

Vous pourrez ensuite valider la correction des conflits en poussant :

git add .
git commit -m 'Résolution des conflits'

8. Continuer le développement

Répétez ces étapes pour chaque nouvelle fonctionnalité ou correction de bug.