diff --git a/README.md b/README.md index fe1d094b6c7ea97933ac707fb9a8dc0d11649dd9..b871323982a6a98309296a2d971e3114eecef84f 100644 --- a/README.md +++ b/README.md @@ -16,4 +16,14 @@ Liste des modèles disponibles : Le document maître du rapport se situe à la racine (`rapport_irstea.tex`...), les documents dépendant du modèle sont dans dossier portant le même nom que le document maître. -Le contenu du rapport (qui peut être indépendant du modèle utilisé) se trouve dans le dossier `contenu`. \ No newline at end of file +Le contenu du rapport (qui peut être indépendant du modèle utilisé) se trouve dans le dossier `contenu`. + + +## Signaler un bug / proposer une amélioration + +Vous pouvez me contacter par mail david.dorchies@irstea.fr ou poster un ticket https://gitlab.irstea.fr/david.dorchies/latex_models/issues/new. + +Vous pouvez aussi forker ce projet et proposer des pull-request. Concernant la charte de programmation, plusieurs principes guident le code de ce modèle : + +* Eviter autant que possible la redondance de code (d'où l'utilisation du dossier `contenu` commun et la référence à `rapport_francais` pour tous les rapports en français) +* Documenter l'utilisation des packages et macros avec un lien donnant le contexte d'utilisation du package ou de la macro. \ No newline at end of file