Github

Page destinée à expliquer les différents poins que Github apporte à Git.

Markdown

Tout ce qui est rédigé sur Github est en markdown. Le markdown est un langage qui se compile vers du html et qui donne rapidement et facilement des rendus simples et clairs.

A savoir

Référence vers un fichier et un numéro de ligne : https://github.com/statox/caramel/blob/master/system/index.html#L3-6

les suivants ne marchent que pour un commit

Référence vers utilisateurs : @statox

Référence vers un commit : fd2388ff575069d4b5bbd4af7105b8903cfc42c5

Issues

Cette section (qui se trouve sur le panneau de droite avec le logo (!) (le rond avec le point d'exclamation dedans)) propose plusieurs fonctions utiles :

• Faire un suivi de toutes les taches du projet
• Attribuer à chaque tache un des collaborateur du projet
• Attribuer à la tache un/plusieurs tag

L'utilisation de base est la suivante : Je regarde le projet, je remarque une erreur que je ne peux pas corriger comme ça où qu'il faudrait étudier avant de corriger : Je crée une issue, je met le maximum d'information dedans, une date, un contexte, ... Ensuite on peur poster des commentaires et débattre du sort de cet issue avant de faire un correctif ou non.

• Dans le cas où un correctif est nécessaire, le responsable de ce correctif s'attribut l'issue. Il en a la responsabilité.
• Dans le cas où l'issue ne présente pas de correction à apporter NE PAS LA SUPPRIMER, lui donner un tag (wontfix, ou autre) et la définir comme résolue, de la sorte on peut avoir un historique des issues et ne pas en ouvrir une 2e déjà traitée dans le passé.

Milestones est un ajout que l'on peut faire à une issue quand on décide de lui donner une date butoir. C'est une issue avec un temps déterminé de rendu.