Participer à ce projet¶
Pydiderot¶
L’objectif de ce projet est de construire des outils adaptées à l’enseignement et l’apprentissage du langage python dans l’enseignement secondaire.
C’est un travail collaboratif sous licence MIT initié par des enseignants du lycée Denis Diderot à Marseille.
Toute participation est la bienvenue tant sur le code que le coté pédagogique : remarques, retours de tests, codes, documentation…
Si vous pensez participer nous vous en remercions et fournissons ce guide pour vous aider.
Les volets du projet¶
- l’environnement pydiderotIDE
- la librairie python pydiderotlibs
- un volet pédagogique en développement pydago
J’ai un problème, une idée, une remarque¶
Nous utilisons les issues github pour gérer cela. Vérifiez si votre cas est déjà présent dans la liste d’issues et n’hésitez pas à en ouvrir si besoin.
Conventions de code et de commentaires¶
Style du code¶
Merci de fournir un code respectant les standards de style PEP8. Si cela vous semble compliqué, sachez que le code sera testé automatiquement avec flake8 et nous vous aideront à modifier votre PR si besoin.
Commentaires¶
Merci de commenter le code python en utilisant la convention google:
def trace_texte(x, y, texte, couleur='black'):
"""Trace un texte dans la fenêtre graphique au coordonées `x, y`.
Arguments:
x (float): abscisse du point
y (float): ordonnée du point
texte (str): Texte à placer dans la fenêtre graphique
couleur (str, optionel): Couleur du texte ('black' par défaut)
"""
Nous utilisons sphinx et l’extension napoleon pour construire la documentation à partir de ces doc-strings.
Je veux aider à documenter¶
La documentation de ce projet est construire avec Sphinx à partir du dossier doc du dépôt github. N’hésitez pas à proposer des ajouts ou corrections!
Si vous souhaitez tester la documentation sur votre ordinateur, jetez un œil à ce document.