Aller au contenu

Soumission de votre travail

Une fois votre dépôt créé après avoir accepté la tâche, vous pouvez suivre les étapes suivantes pour récupérer votre dépôt et commencer à travailler sur votre compte rendu sur votre ordinateur.

1. Récupération du dépôt

Clonez le dépôt que vous avez créé en acceptant la tâche.

Cloner un dépôt ?

Cloner un dépôt signifie copier le code source d'un dépôt distant (GitHub) sur votre ordinateur pour y travailler localement.

Comment trouver le lien de mon dépôt ?

Vous pouvez trouver le lien de votre dépôt sur la page de la tâche que vous avez acceptée.

d39c4b033cd2d9cd.png

git clone [git@github.com:username/nom-tache-a-faire.git] # (1)!
  1. Remplacez [git@github.com:username/nom-tache-a-faire.git] par le lien de votre dépôt.
git clone [https://github.com/username/nom-tache-a-faire.git] # (1)!
  1. Remplacez [https://github.com/username/nom-tache-a-faire.git] par le lien de votre dépôt.
Remarque

Par défaut, le dossier cloné aura le nom du dépôt par exemple nom-tache-a-faire. Vous pouvez changer le nom du dossier en ajoutant un nom après le lien du dépôt.

git clone [lien.git] [nom-du-dossier]

2. Creation de la branche dev

  1. Accédez au dossier de votre dépôt cloné.

    cd [nom-du-dossier]
    
    Problème avec le nom du dossier ?

    Si vous avez changé le nom du dossier lors du clonage, assurez-vous de remplacer [nom-du-dossier] par le nom du dossier que vous avez choisi.

  2. Créez une branche nommée dev pour travailler sur votre compte rendu.

    git branch dev
    git checkout dev
    

    Ou en une seule commande

    git checkout -b dev
    
    Problème avec la branche dev ?

    Si la branche dev existe déjà, vous pouvez la sélectionner directement.

    git checkout dev
    

    Verifiez que vous êtes sur la branche dev en utilisant la commande git branch.

    git branch
    
      main  # Ou master
    * dev   # L'astérisque (*) indique la branche active
    

3. Travail à faire

Pour faire votre compte rendu, vous devez suivre l'énoncé du fichier README (travail à faire). Vous allez créer une application Android sous le dossier application et répondre aux questions dans le fichier README .

  1. Créez votre application Android (voir README) sous le dossier application.

    mkdir application
    
  2. Répondez aux questions dans le fichier README en mettant X entre crochets [ ].

    1
    2
    3
    4
    * [ ] **(a)** `MainActivity.java`
    * [ ] **(b)** `AndroidManifest.xml`
    * [ ] **(c)** `activity_main.xml`
    * [ ] **(d)** `build.gradle`
    
    1
    2
    3
    4
    * [ ] **(a)** `MainActivity.java`
    * [ ] **(b)** `AndroidManifest.xml`
    * [ ] **(c)** `activity_main.xml`
    * [X] **(d)** `build.gradle`
    
  3. Une fois que vous avez terminé de travailler sur votre projet, vous devez sauvegarder vos modifications dans votre dépôt local avec un commit. Il est recommandé de faire des commits réguliers après chaque modification significative.

    1
    2
    3
    4
    5
    6
    7
    8
    # Vérifier les fichiers modifiés
    git status
    
    # Ajouter tous les fichiers modifiés
    git add --all # ou "git add ." pour ajouter tous les fichiers
    
    # Enregistrer les modifications avec un message descriptif
    git commit -m "Ajout de la fonctionnalité X"
    

    Si vous devez apporter d'autres modifications ou corrections, répétez les commandes ci-dessus.

    Utilisez la commande :

    1. git status pour vérifier les fichiers modifiés.
    2. git add pour ajouter les fichiers que vous avez modifiés.
    3. git commit pour enregistrer ces modifications. (N'oubliez pas d'ajouter un message descriptif à chaque commit.)

    Faites cela à chaque fois que vous apportez des changements.

Un exemple de structure finale de votre dépôt (branche dev)
nom-tache-a-faire # (1)!
├── application  # (2)!
   ├── app
      ├── build.gradle
      ├── proguard-rules.pro
      └── src
          ├── androidTest
          ├── main
             ├── AndroidManifest.xml
             ├── java
                └── com
                    └── example
                            └── myapplication
                                └── MainActivity.java
             └── res
          └── test
   ├── build.gradle
   ├── gradle
      ├── libs.versions.toml
      └── wrapper
          ├── gradle-wrapper.jar
          └── gradle-wrapper.properties
   ├── gradle.properties
   ├── gradlew
   ├── gradlew.bat
   ├── local.properties
   └── settings.gradle
├── images # (3)!
├── .github # (4)!
├── .git # (5)!
├── .gitignore # (6)!
├── LICENSE
└── README.md # (7)!
  1. Dossier de votre dépôt cloné.
  2. Dossier de votre application (à créer)
  3. Dossier pour les images utilisées dans README.md
  4. Dossier caché pour les fichiers GitHub (actions, workflows, etc.) à ne pas toucher.
  5. Dossier caché de git. (si vous le supprimez, vous perdrez l'historique de vos modifications)
  6. Fichier pour ignorer les fichiers et dossiers à ne pas suivre avec git.
  7. Fichier README.md pour les instructions et les réponses aux questions à cocher.

4. Soumission de votre travail

Une fois que vous avez terminé de travailler sur votre compte rendu, vous devez pousser vos modifications vers votre dépôt distant.

git push -u origin dev
Note

Si vous avez déjà poussé la branche dev vers votre dépôt distant, vous pouvez simplement utiliser la commande :

git push

Félicitations !

Vous avez terminé votre travail et vous avez soumis votre compte rendu avec succès.

Sur GitHub, vous pouvez voir votre branche dev avec les modifications que vous avez apportées.

N'utilisez jamais l'envoi forcé

N'utilisez jamais git push --force, cela peut entraîner la perte de données. Consultez votre enseignant si vous avez des problèmes avec votre dépôt.

Problème avec le dossier application qui ne contient pas votre travail ?

  • Assurez-vous que vous avez bien créé votre application Android sous le dossier application.
  • Assurez-vous que vous avez commité vos modifications avant de pousser votre travail.
  • Si l'icône d'un dossier apparaît comme ceci , cela signifie que le dossier est un sous-module Git. Pour résoudre ce problème :

    1. Vérifiez si un dossier caché .git existe dans le dossier application

      1
      2
      3
      4
      nom-tache-a-faire
      └── application
          └── .git # (1)!
          └── sous-dossier-contenant-votre-application # (2)! 
      
      1. à supprimer (dossier caché)
      2. Votre application ne doit pas être dans un sous-dossier. Le contenu de votre projet doit être directement dans le dossier application. Si ce n'est pas le cas, déplacez les fichiers de votre application dans le dossier application.
    2. Si oui, supprimez-le : rm -rf application/.git

    3. Ajoutez à nouveau vos fichiers avec git add application
    4. Commit et poussez vos modifications.

5. Ouverture d'une Pull Request

Une fois que vous avez poussé votre branche dev vers GitHub, vous devez créer une Pull Request (PR) pour que votre enseignant puisse examiner votre travail.

Qu'est-ce qu'une Pull Request ?

Une Pull Request (PR) est une demande pour intégrer les modifications d'une branche vers une autre branche (généralement de dev vers main). Elle permet de visualiser les changements, de les commenter et de les valider avant de les fusionner.

Étapes pour créer une Pull Request

  1. Accédez à votre dépôt sur GitHub

    Ouvrez votre navigateur et allez sur la page de votre dépôt GitHub.

  2. Cliquez sur "Compare & pull request"

    Après avoir poussé votre branche dev, GitHub affichera automatiquement un bouton jaune "Compare & pull request" en haut de la page. Cliquez dessus.

    Compare and pull request button

    Le bouton n'apparaît pas ?

    Si le bouton jaune n'apparaît pas :

    1. Cliquez sur l'onglet "Pull requests"
    2. Cliquez sur le bouton vert "New pull request"
    3. Sélectionnez main comme branche de base (base branch)
    4. Sélectionnez dev comme branche à comparer (compare branch)

    Compare and pull request page

  3. Remplissez les informations de la Pull Request

    • Base branch : Assurez-vous que la branche de base est main (ou master)
    • Compare branch : Assurez-vous que la branche à comparer est dev
    • Titre : Donnez un titre descriptif à votre PR (par exemple : "Compte rendu TP1 - Prénom Nom")
    • Description : Ajoutez une description de votre travail (optionnel mais recommandé)

    Pull request form

  4. Créez la Pull Request

    Cliquez sur le bouton vert "Create pull request" pour créer votre PR.

    Create pull request button

  5. Vérifiez votre Pull Request

    Une fois la PR créée, vous pouvez voir :

    • Les fichiers modifiés dans l'onglet "Files changed"
    • Les commits effectués dans l'onglet "Commits"
    • Les discussions et commentaires dans l'onglet "Conversation"

    Pull request overview

Pull Request créée !

Votre Pull Request est maintenant visible par votre enseignant qui pourra examiner votre travail, laisser des commentaires et l'évaluer.

Ne fusionnez pas la Pull Request

Ne cliquez PAS sur le bouton "Merge pull request". Votre enseignant s'occupera de la fusion après l'évaluation de votre travail.

Modifications supplémentaires

Si vous devez apporter des modifications supplémentaires après avoir créé la PR :

  1. Faites vos modifications sur la branche dev localement
  2. Commitez vos changements : git commit -m "Message descriptif"
  3. Poussez vers GitHub : git push

Les modifications seront automatiquement ajoutées à votre Pull Request existante.