SAÉ 3.01 2023-2024

💡	Pensez à mettre à jour les infos dans ce fichier pour que les badges pointent sur les résultats effectifs de vos intégrations continue ou sur la bonne licence logicielle.

⚠️	Ce dépôt présente le projet à développer dans le cadre de la SAÉ 3.01 du BUT1 Informatique de l’IUT de Blagnac.

Ce fichier README.adoc (dont vous lisez sûrement le rendu HTML automatiquement effectué par GitHUb), fait partie du dépôt initial cloné à partir du lien GitHub classroom qui vous a été donné en cours (https://classroom.github.com/a/fePVlfpN). Vous trouverez le dépôt "template" qui a servi de base ici : https://github.com/IUT-Blagnac/sae3-01-template. En complément du cours Moodle de la SAE 3.01 (cf. Liens utiles), ce dépôt template vous permet d’accéder à des exemples d’issues, de releases, ou d’autres artefacts à venir.

• 1. Equipe
• 2. Contexte général
  • 2.1. Dépôt initial
  • 2.2. Liens utiles
• 3. Réalisations
• 4. Gestion de projet & Qualité

1. Equipe

Projet est réalisé par

• Jane Doe

• John Smith …​

Tuteur/tutrice enseignant(e) de l’équipe

JMB

2. Contexte général

💡	Cette partie de votre README.adoc peut être supprimée ou mise ailleurs.

2.1. Dépôt initial

Ce dépôt initial a été créé pour que tous les groupes de 2ème année aient les mêmes informations de départ.

Vous y trouverez des fichiers qui peuvent être supprimés s’ils ne vous sont pas utiles :

• .gitignore ⇒ un fichier minimaliste des éléments à ne pas pousser en général sur vos dépôts (utiliser la commande git add -f pour forcer l’ajout d’un fichier Jar qui ne bougera plus, pour archive par exemple).

• .github ⇒ le répertoire qui contient des éléments de gestion de projet :

  • workflows ⇒ le repertoire qui contient les actions à lancer à chaque push sur votre repo.

    • blank.yml ⇒ un exemple bidon mais dont vous pourrez vérifier l’exécution correcte (1er tag)

  • ISSUE_TEMPLATE ⇒ le repertoire qui contient quelques templates pour vos issues.

    • us.yml ⇒ Exemple de template pour les User Stories

    • bug.yml ⇒ Exemple de template pour les issues de bug report

💡	Adaptez ces fichiers à votre projet et à votre organisation. Et inspirez-vous en pour en ajouter.

2.2. Liens utiles

• Le cours Moodle sur la SAE

• Le dépôt template qui sert de base à tous les dépôts étudiants.

• Le lien classroom si besoin.

💡	Pensez à utiliser les salons Discord dédiés pour poser vos questions.

3. Réalisations

💡	Mettez ici toutes les informations nécessaire à l’utilisation de votre dépôt (comment on installe votre application, où sont les docs, etc.)

4. Gestion de projet & Qualité

Chaque sprint (semaine) vous devrez livrer une nouvelle version de votre application (release). Utilisez pour cela les fonctionnalités de GitHub pour les Releases.

De plus ce fichier README.adoc devra être à jour des informations suivantes :

• Version courante : v0.1.2

• Lien vers la doc technique

• Lien vers la doc utilisateur

• Liste des (ou lien vers les) User Stories (ToDo/Ongoing/Done) et % restant

• Tests unitaires et plans de test

• Indicateurs de qualité du code (dette technique)

• …​ tout autre élément que vous jugerez utiles pour démontrer la qualité de votre application

Voici un exemple d’évaluation :