From eb816f6efcbaa8c7ca3fd3c698fc460852f1459d Mon Sep 17 00:00:00 2001 From: Emmanuel Viennet Date: Wed, 23 Dec 2020 09:01:25 +0100 Subject: [PATCH] =?UTF-8?q?M=C3=A9mo=20git=20etc.?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/Developpement.md | 45 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 45 insertions(+) create mode 100644 docs/Developpement.md diff --git a/docs/Developpement.md b/docs/Developpement.md new file mode 100644 index 000000000..6cc2838be --- /dev/null +++ b/docs/Developpement.md @@ -0,0 +1,45 @@ +## Développer sur ScoDoc 7 + +Quelques conseils, indications et mémos pour les développeurs sur ScoDoc version 7.x. + +### Style et formatage du code +L'ancienneté de la base de code a rendu le style peu cohérent. + +Le code doit être formatté avec [`black`](https://black.readthedocs.io/) avant tout commit (configurez votre éditeur pour appeler `black`à l'enregistrement). + +### Git + +Le dépot est + +La branche `master` est celle en production. La branche `Scodoc8`est expérimentale (nouvel installeur, refactoring...). ScoDoc9 sera avec Python 3. + +#### Hot fixes (internes) + +Pour les développeurs internes (écriture sur le dépot master): + + # Créer une branche + # si besoin (travail en cours), utiliser git stash avant + git checkout master + git branch hotfix + git checkout hotfix + ... dev, test ... + git add ... + git commit -m "fixed ..." + git checkout master + git merge hotfix + git branch -d hotfix + # publication + + # éventuellement: git stash pop + +#### Mettre à jour votre branche + +Vous travaillez dans votre branche `ma_branche`. Pour lui appliquer les mises à jour de `master`: + + git pull origin master + + +### Refactoring + + pylint --disable=all -e E sco_parcours_dut.py | grep undefined-variable | awk '{print $4;}' | sort | uniq | tr -d \' +