2024-02-10 17:16:32 +01:00
# Comment contribuer à ce projet
2024-04-28 15:58:22 +02:00
2024-02-10 17:16:32 +01:00
2 cas sont possibles pour contribuer à ce projet:
2024-04-28 15:58:22 +02:00
- Vous ête un étudiant et l'utilisez pour créer votre projet, dans ce cas reportez vous
à [la section étudiant ](#etudiant )
- Vous êtes un enseignant améliorant ce modèle, dans ce cas reportez vous
à [la section enseignant ](#enseignant )
2024-02-10 17:16:32 +01:00
## Etudiant
2024-04-28 15:58:22 +02:00
Vous ne devez pas contribuer directement à ce projet mais devez en effectuer un fork. Une fois cela
effectué vous devez:
- [x] Ajouter votre identifiant de groupe au champs `groupId` du fichier [pom.xml ](pom.xml ) sous la
forme de `fr.u-paris.gla.votreequipe`
2024-02-10 17:16:32 +01:00
- [ ] Modifier le package principal afin de refleter le nouveau nom de groupe.
- [ ] Adapter le fichier [README ](README.md ) au contenu de votre projet specifique
- [ ] Adapter ce fichier (CONTRIBUTING.md) à vos propres instructions de contribution, notamment:
2024-04-28 15:58:22 +02:00
- [ ] Convention de style de codage
- [ ] Convention d'utilisation de git
- [ ] Lien avec d'autres projets et d'autres dépôts.
- [x] Modifier le fichier `application.properties` au besoin.
2024-02-10 17:16:32 +01:00
2024-04-28 16:10:31 +02:00
## Convention de style
Nous utilisons la convention de style de Google. Cette convention
est [accessible en détail ici ](https://google.github.io/styleguide/javaguide.html ). Pour proprement
configurer son IDE, Google propose plusieurs fichiers de
configuration [disponible ici ](https://github.com/google/styleguide ).
## Convention Git
Merci de se référer
au [wiki développeur concernant la convention des commits ](https://moule.informatique.univ-paris-diderot.fr/gla-groupe-3/projet/-/wikis/dev-wiki#commits ).
2024-02-10 17:16:32 +01:00
## Enseignant
2024-04-28 15:58:22 +02:00
Ce dépôt suit la convention de gitflow. Les modifications doivent être effectuées dans des branches
séparées,
2024-02-10 17:16:32 +01:00
intégrées dans la branche dev une fois terminée.
La branche main ne doit contenir que des versions stables de ce modèle.
2024-04-28 15:58:22 +02:00
Le code est écrit en Java, manipulé par l'outils de construction maven et doit suivre les
conventions usuelles du langage et de l'outils.
2024-02-10 17:16:32 +01:00
Le package principal du code Java est `fr.u_paris.gla.project`
2024-04-28 15:58:22 +02:00
Le fichier de properties `application.properties` permet d'accéder depuis le code Java aux diverses
informations inscrite dans maven.
