Introduction à notre GitHub
Afin de permettre à un maximum de personnes (y compris les non informaticiens) d'utiliser cette plateforme, voici un petit topo sur l'utilisation de l'espace de discussion et d'écriture collaborative qu'offre GitHub.
L'ensemble du projet est accessible « en lecture » sans inscription, cependant si vous souhaitez participer (proposer des modifications, etc.), il vous faudra créer un compte GitHub.
Voir le fichier README.MD pour la liste des principaux fichiers du projet et leurs rôles.
Ces fichiers sont écrits au format Markdown (language de mise en forme très simple, qu'on peut apprendre en cinq minutes)
Leur rédaction est collaborative : n'importe qui avec un compte GitHub peut proposer, à tout moment, une modification à l'aide du mécanisme de Pull Request (PR) décrit en détail plus bas.
Pour le moment, quelques modérateurs autoproclamés 😉 se chargent de discuter/valider les PR, mais cela peut évoluer.
- Si ce n'est pas encore fait, créez un compte GitHub
- Authentifiez-vous sur github et autorisez l'application prose.io
- Depuis une page de dirtylab.github.io, cliquez sur
, en bas à gauche du document à éditer. - Vous avez été redirigés sur prose.io. Faites les modifications désirées puis appuyer sur le
. - Renseignez une phrase qui décrit la modification puis validez. Si vous rencontrez une erreur, pas de panique! Copiez tout le texte puis collez-le dans un endroit sur (fichier texte). Essayez ensuite la deuxième méthode. Le cas échéant, merci de nous le signaler dans notre canal #aide de notre messagerie slack
- Une Pull Request apparait alors dans le forum et les gens peuvent commenter cette proposition
- L'équipe de validation confirme l'édition.
- Si ce n'est pas encore fait, créez un compte GitHub
- Authentifiez-vous sur github
- Sélectionnez le fichier à modifier
- Directement depuis github : par ex. README.MD
- Avec le bouton d'édition github depuis une page de dirtylab.github.io :
- Appuyez sur
- Faites vos modifications
- En bas de la page, section Propose file change :
- Renseignez une phrase qui décrit la modification
- Appuyez sur
- Une Pull Request apparait alors dans le forum et les gens peuvent commenter cette proposition
- L'équipe de validation confirme l'édition.
Relativement complexe pour un non informaticien (notamment pour s'assurer que son fork est synchro avec le dépôt original. Il existe des manières de le faire directement sur GitHub.com mais c'est relativement lourd tout ça).
Guide officiel GitHub.com (anglais)
II. Forum/Issue tracker
L'onglet issues, normalement prévu pour répertorier les bugs/problèmes d'un logiciel, est ici utilisé comme un forum de discussion (1 issue = 1 fil/topic).
Comme dans un forum classique, merci d'utiliser la barre de recherche en haut de la liste pour vérifier qu'une issue existante ne traite pas déjà du sujet que vous souhaitez aborder.
Si vous n'en trouvez pas, créez un nouveau topic/issue, en donnant un titre court et explicite, et en décrivant précisément ce que vous souhaitez évoquer (améliorer l'organisation du fichier X, approfondir la réflexion sur le sujet Y...).
NB : lors de la migration de dépot depuis github/sveinburne/lets-play-sciences, les posts du forum github ont été transférés automatiquement sans préserver les auteurs! C'est pourquoi ils sont tous signés sveinburne.
Si GitHub vous rebute, n'hésitez pas à poser vos questions ou faire des propositions sur le forum Reddit.
II.1. Labels
Chaque sujet (issue, pull request) peut être associé à un ou plusieurs labels qui permettent une classification, aidant à retrouver plus facilement certains thèmes de discussion. Lire ce post sur la signification de chaque label.
II.2. Filtres
Le moteur de recherche des topics/issues permet l'utilisation de filtres. Voici des filtres utiles :
is:issue(toutes les issues, c'est à dire "posts")is:pr(toutes les pull request, PR)sort:updated-desc(trier par modifié le plus récemment d'abord)is:open(tous les sujets ouverts)is:closed(tous les sujets fermés)label:épinglé(tous les sujets épinglés)-label:épinglé(tous les sujets qui ne sont pas épinglés)
Les filtres peuvent se cumuler, exemple -label:épinglé is:open
Vous pouvez aussi utiliser l'interface graphique, boutons Filters, Labels, Sort (tri) ... etc
Pour plus de fonctionnalités sur les filtres, voir le guide officiel (en anglais).
III. Tchat
La plateforme Slack (avec intégration Github), est utilisée. Les inscriptions se font ici..
Avantages :
- L'historique des interventions est conservé, donc on peut laisser un commentaire même s'il n'y a personne d'autre à ce moment là.
- La liste des derniers "événements" qui ont eu lieu sur le repository GitHub LetsPlayScience s'affiche automatiquement dans le canal #github.
- Un canal d'#annonces répertorie les nouvelles de la communauté depuis les comptes twitter et facebook.
Quand utiliser Slack, Reddit ou le Forum?