Skip to content

Latest commit

 

History

History
69 lines (52 loc) · 2.49 KB

CONTRIBUTORS.md

File metadata and controls

69 lines (52 loc) · 2.49 KB
Raw

Pour les auteurs des corrections

Organisation

Le répertoire est organisé de la manière suivante :

|── CODE_UE
|   ├── TD1
|   ├── TD2
|   └── TDi
├── CODE_UE2
├── CODE_UE3
├── CONTRIBUTORS.md
└── README.md

Il y a un dossier pour chaque matière et un sous-dossier par TD/TP.

Chaque contributeur pourra poser sa correction dans n'importe quel dossier. Il suffit de suivre les conventions suivantes :

  • pour les TD
    • déposer seulement le PDF
    • le nommer de la manière suivante : InitialePrenomInitialeNom-TDX.pdf (i.e. : AS-TD1.pdf si le créateur de ce répertoire ajoute le pdf du TD1 d'une certaine matière).
  • pour les TP
    • déposer un dossier, avec les sources compilables et un makefile
    • pas d'exécutable, ni de fichiers « inutiles » (comme des fichiers .dat qui résultent de l'utilisation de l'exécutable généré par exemple)
    • le dossier devra être nommé de la manière suivante : InitialePrenomInitialeNom-TPX (i.e. : AS-TP1 si le créateur de ce répertoire ajoute la correction du TP1 d'une certaine matière)

Droits d'auteur

Aucun sujet de TD/TP ne doit être déposé dans ce répertoire.

Aucun CM ne doit être déposé dans ce répertoire.

Tout le code déposé devra comporter une entête, avec au minimum 2 champs :

/**
 * Auteur: nom de l'auteur
 * Date: date de création du fichier
 **/

LaTeX

Pour une correction uniforme en LaTeX, un entête est fourni dans le dossier et il est recommandé de l'utiliser. Cet entête permet de définir l'unité d'enseignement, les auteurs, et le nom du TD. Pour l'utiliser, il suffit de définir les 3 macros suivantes :

% ...

\newcommand\autors{...}
\newcommand\UE{HAI70XI - Nom de l'UE}
\newcommand\Title{TD X - Nom du TD}

\begin{document}
    \input{header}

    % ...
\end{document}

De plus, il est recommandé d'utiliser le site madebyevan.com/fsm pour la création d'automates en LaTeX si vous débutez.

Commit

Un commit doit être composé d'au moins un titre, qui suit le format suivant : [InitialePrenomInitialeNom] [UE] Titre. Par exemple :

[AS] [HAI704I] Corrections de tous les exercices de calculabilité.

Branches

Nous travaillons tous sur la même branche, vu que seulement le travail fini devra être push. N'oubliez donc pas de pull avant de push pour éviter les conflits ! Si vous n'avez pas pull avant de commit, vous pouvez tout de même rebase sur la branche distante.