Synthèses de l'EPL

Documentation	PDF	Chat	Forum	Git

Les documents présents sur ce repository sont des documents mis à disposition pour les étudiants de l'EPL.

Visualisation des synthèses et correctifs

Les .pdf des synthèses et correctifs dans leur dernière version sont disponibles ici.

Historique

Ce projet a été lancé en 2011 par Nicolas Cognaux (Gp2mv3). Benoît Legat (blegat) a rejoint le projet en 2011 et a endossé le rôle de maintainer à partir de là. Le 18 Août 2018, le rôle a été transmis à Martin Braquet (MartinBraquet), Gilles Peiffer (Peiffap) et Jean-Martin Vlaeminck (Jimvy).

Le projet est à ce jour sans maintainer ! Nous sommes à la recherche d'étudiants motivés pour prendre une des composantes suivantes de ce rôle:

1. Mettre à jours les pdfs sur le drive.
2. Reviewer les pull requests des autres étudiants, voir Processus de review.

Pour vous récompenser de ce travail, vous serez rémunérés copieusement en visibilité.

Processus de review

Voici les règles régissant la review des pull requests:

1. Tout le monde est encouragé à laisser des commentaires.
2. Si c'est un ajout ou une modification d'un contenu par l'auteur original, les maintainers ne doivent pas vérifer l'exactitude, ils doivent uniquement vérifier que ça compile et que les fichiers ont été ajoutés au bon endroit. Un maintainer a le droit de faire de l'excès de zèle et faire une review plus approfondie car les maintainers ont tout pouvoir.
3. Si c'est une modification d'un auteur différent que l'auteur original et qu'un maintainer est confiant, il peut merger. Sinon, il peut tagger l'auteur original et/ou demander à l'auteur du pull request de donner plus de précision pour l'aider à confirmer que la modification est bien correcte.

Documentation

Ce README donne quelques premières indications quant à l'utilisation de ce repository. Pour de plus amples informations, voir le guide pour les nouveaux contributeurs ou le wiki.

Comment contribuer

La façon la plus simple de contribuer est de suggérer des améliorations en soumettant une issue sur le bug tracker. Même pour une simple faute d'orthographe, ça vaut la peine de le signaler.

Vous pouvez aussi directement modifier le code et nous le soumettre en utilisant git; le guide pour les nouveaux contributeurs donne une explication rapide de comment faire cela. Pour une explication plus détaillée, lisez la partie Utilisation linéaire de Git de ce tutoriel écrit par Benoît Legat. Voir aussi le wiki à ce sujet.

Nous vous recommandons d'utiliser le système des branches de Git, qui permettent d'avoir en parallèle des changements différents sur des documents différents (par exemple, un changement sur la synthèse de physique 1 et un ajout d'examen en algèbre), avec la possibilité de facilement passer d'un groupe de changements à l'autre, et d'ainsi ouvrir plusieurs pull requests, une par groupe de changements/thématique. Cela vous permettra aussi de garder une branche master propre et qui peut facilement être mise à jour avec ce repository (fast-forward).

Vous pouvez visualiser le statut des différentes synthèses ici. N'hésitez pas à en rajouter dans la liste :)

Compiler automatiquement les documents en PDF

Vous pouvez compiler automatiquement tous les documents dans leur destination (le dossier où se trouve le fichier .tex) en tapant en ligne de commande à la racine du repository (dossier Syntheses):

• make pdf pour supprimer les fichiers de compilation
• make pour laisser les fichiers de compilation
• make release pour compiler et copier les documents automatiquement dans un dossier de destination à part, que vous aurez préalablement choisi en inscrivant le chemin absolu du dossier dans le fichier compilation.yml (copier et renommer compilation.example.yml en compilation.yml)

License

Sauf mention expresse, vous licensiez sous license CC-BY-SA 4.0 tout le contenu que vous soumettez pour inclusion dans ce dépot.

Si cette license vous pose problème, venez en discuter en ouvrant une issue.