Poser des questions via les issues de GitHub

Dans les cours de science des données à l'UMONS, vous posez vos questions dans les "issues" (nous avons choisi délibérément de garder le terme anglais qui apparaît dans GitHub pour nommer cela). Vous avez une section issues dans chaque dépôt GitHub (questions spécifiques à ce dépôt), et dans le présent dépôt (questions générales du cours).

Avant de vous lancer tête baissée dans la rédaction de votre question, essayez d'y répondre par vous-même. Lisez bien le message d'erreur s'il y en a un. Posez votre question au chatbot spécialisé mis à votre disposition. Recherchez sur Internet avec des mots clés et/ou le message d'erreur. Expérimentez des variations de votre code.

Quoi qu'il en soit, même après avoir posé votre question, vous ne restez pas les bras croisés à attendre la réponse. Soit, vous faites autre chose pour avancer votre projet pendant ce temps, soit vous continuez à chercher la réponse par vous-même si le problème est bloquant.

Comment créer une nouvelle issue dans le dépôt central ?

• Depuis le cours en ligne à http://bds.sciviews.org, vous cliquez sur Issues dans le bandeau rouge supérieur pour sélectionner ensuite le dépôt central des issues de votre cours. Enfin, vous cliquez sur le bouton New Issue pour en créer une nouvelle.

• Depuis RStudio, vous déroulez le menu du bouton Addins, vous allez à la section correspondant à votre cours (BioDataScience1, 2, ou 3) et sélectionnez New sdd X Issue où X est I, II ou III selon votre cours. Lisez bien le message qui apparaît et cliquez sur le lien.

Comment créer une nouvelle issue spécifique à un dépôt GitHub ?

• Vous êtes très probablement en train de travailler dans le projet correspondant dans RStudio. Vous déroulez le menu du bouton Addins, descendez à la section BioDataScience et sélectionnez New repo issue. Lisez bien le message qui apparaît et cliquez sur le lien.

• Si vous êtes déjà dans le dépôt GitHub, cliquez sur l'onglet Issues, puis sur le bouton New Issue

Comment formuler votre question ?

Vous devez remplir le titre et la zone "Leave a comment", puis cliquer sur le bouton vert Submit new issue.

• Indiquez un titre court, mais indicatif de votre problème. Exemple de bon titre : "Erreur lors du chargement des données 'penguins'". Exemples de mauvais titres à ne pas utiliser : "Help, je suis perdu•e!" ou encore "Je ne comprends rien..."

• Remplissez la section "Leave a comment". Commencez par indiquer que vous souhaitez que l'issue soit traitée par un de vos enseignants en écrivant @BioDataScience-Course/teachers (le @quelqu'un cite la ou les personnes et fait en sorte qu'elles soient averties par mail de l'issue). Vous pouvez juste écrire @teach et l'item vous sera proposé dans une liste déroulante pour plus de facilité. Vous pouvez aussi citer vos collègues pour des échanges entre vous. Ensuite, décrivez votre problème avec suffisamment de détails pour que l'on puisse le comprendre et vous aider.

Astuce : Aidez-vous d'une copie d'écran de la zone correspondante pour illustrer votre problème.

Comment faire une copie d'une zone de mon écran et la placer dans les issues ?

Ne capturez jamais tout l'écran, sélectionnez une zone rectangulaire qui contient l'information utile.

• Sous Windows, utilisez la combinaison de touches Windows+Shift+S. Une petite barre d'outils apparaît en haut de l'écran. Assurez-vous que le premier bouton soit sélectionné. Le curseur de souris doit être en forme de croix. Ensuite, cliquez sur le coin supérieur gauche du rectangle et glissez le curseur vers le coin inférieur droit tout en maintenant le bouton enfoncé (ou en maintenant la pression sur le trackpad). Relâchez le bouton de la souris. La zone capturée est placée dans le presse-papier. Retournez vers le commentaire de votre issue, mettez le curseur à l'endroit où vous voulez placer la copie d'écran et utilisez le raccourci clavier Ctrl+V pour coller le contenu du presse-papier.

• Sous MacOS, utilisez la combinaison de touches Command+Shift+4. Le curseur de la souris se transforme en une croix dans un cercle. Cliquez sur le coin supérieur gauche du rectangle à capturer et tirez le curseur vers le coin inférieur droit tout en maintenant le bouton de souris enfoncé (ou en maintenant la pression sur le trackpad). La zone sélectionnée est capturée et placée dans un fichier Screenshot sur votre bureau. Glissez-déposez ce fichier dans la zone de commentaire des issues à l'endroit où vous voulez l'insérer. Vous pouvez ensuite placer ce fichier dans la corbeille : vous n'en avez plus besoin sur votre bureau.

Astuce : sélectionnez l'onglet Preview pour voir le rendu, revenez vers l'onglet Write pour continuer à écrire. Vous pouvez utiliser les formatages Markdown, par exemple, entourer des mots par deux astérisques pour les mettre en gras, comme **ceci**.

Que faire ensuite ?

Créer une nouvelle issue lance en fait une discussion. Il se peut qu'il y ait plusieurs échanges avant de résoudre votre problème. À chaque fois, un mail vous avertira qu'un nouveau message est apparu dans votre issue. Suivez la discussion !

Très important : une fois que vous avez obtenu réponse à votre question, clôturez l'issue en cliquant sur le bouton Close issue ou Close with comment.

Pour devenir expert•e dans l'utilisation des issues GitHub, vous pouvez aussi lire les explications complémentaires dans le sous-dossier /docs ici : https://github.com/BioDataScience-Course/sdd_issues/tree/main/docs.

Code de conduite

Ce dépôt est privé et dédié uniquement aux étudiants et encadrants des cours de science des données biologiques à l'UMONS. Cet espace de travail se veut convivial et les membres peuvent se sentir en confiance.

Comportement attendu

• structurer le contenu du message pour être le plus complet et le plus clair possible
• ne pas abuser de l’écriture en majuscules qui indique que QUELQU'UN EST TRES EN COLERE ET CRIE !
• faire attention à l’orthographe
• ne pas utiliser le langage SMS et limiter au strict minimum l'usage des émoticônes

Comportement inacceptable

Les moqueries ou les insultes sont évidemment interdites.