From 66957750bad8e97d02468c05436e298ce0f643f2 Mon Sep 17 00:00:00 2001 From: Soldat Date: Fri, 5 Oct 2018 23:03:45 +0200 Subject: [PATCH] Ajout de black dans contributing --- .gitignore | 1 + CONTRIBUTING.md | 18 ++++++++++++++++++ 2 files changed, 19 insertions(+) diff --git a/.gitignore b/.gitignore index c350ed9e..76fd8b83 100644 --- a/.gitignore +++ b/.gitignore @@ -4,6 +4,7 @@ db.sqlite3 *.mo *__pycache__* .DS_Store +.vscode/ env/ doc/html data/ diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 4805805e..02b1a74f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -37,6 +37,24 @@ Et pour lancer le sith, tu fais `python3 manage.py runserver` Voilà, c'est le sith AE. Il y a des issues dans le gitlab qui sont à régler. Si tu as un domaine qui t'intéresse, une appli que tu voudrais développer, n'hésites pas et contacte-nous. Va, et que l'AE soit avec toi. +Black +------------------ +Pour uniformiser le formattage du code nous utilisons [Black](https://github.com/ambv/black). Cela permet d'avoir le même codestyle et donc le codereview prend moins de temps. Tout etant dans le même format, il est plus facile pour chacun de comprendre le code de chacun ! Cela permet aussi d'éviter des erreurs (y parait 🤷‍♀️). + +Installation de black: + + cd Sith + virtualenv --clear --python=python3 env_sith + source env_sith/bin/activate + pip install black + +Sous VsCode: +Ajouter ces deux lignes dans les settings de VsCode + + "python.formatting.provider": "black", + "editor.formatOnSave": true, + + Sites et doc cools ------------------