Remerciez-le!

Remerciez @Admin pour avoir partagé cet document gratuitement, de la manière la plus simple, en partageant sur les réseaux sociaux.

Bonnes pratiques ...et mauvaises pratiques Alexis Polti Avec de vrais morceaux

Bonnes pratiques ...et mauvaises pratiques Alexis Polti Avec de vrais morceaux de vous dedans ! 12 février 2019 © Alexis Polti SE203 page 2 Licence de droits d'usage Par le téléchargement ou la consultation de ce document, l’utilisateur accepte la licence d’utilisation qui y est attachée, telle que détaillée dans les dispositions suivantes, et s’engage à la respecter intégralement. La licence confère à l'utilisateur un droit d'usage sur le document consulté ou téléchargé, totalement ou en partie, dans les conditions définies ci-après, et à l’exclusion de toute utilisation commerciale. Le droit d’usage défini par la licence autorise un usage dans un cadre académique, par un utilisateur donnant des cours dans un établissement d’enseignement secondaire ou supérieur et à l’exclusion expresse des formations commerciales et notamment de formation continue. Ce droit comprend : ● le droit de reproduire tout ou partie du document sur support informatique ou papier, ● le droit de diffuser tout ou partie du document à destination des élèves ou étudiants. Aucune modification du document dans son contenu, sa forme ou sa présentation n’est autorisé. Les mentions relatives à la source du document et/ou à son auteur doivent être conservées dans leur intégralité. Le droit d’usage défini par la licence est personnel, non exclusif et non transmissible. Tout autre usage que ceux prévus par la licence est soumis à autorisation préalable et expresse de l’auteur : alexis.polti@telecom-paristech.fr Contexte académique } sans modification 12 février 2019 © Alexis Polti SE203 page 3 tl;dr Travaillez proprement. Prenez le temps qu'il faut pour ça. 12 février 2019 © Alexis Polti SE203 page 4 Écriture de code Code non indenté → code inexistant Pas de Makefile → code inexistant Code non ou mal commenté → code inexistant mauvais commentaires : paraphrase « code-poisoning » art moderne code mort bons commentaires : mentions légales intention TODO / XXX subtilités non évidentes préférer un bon nommage à des commentaires superflus 12 février 2019 © Alexis Polti SE203 page 5 Écriture de code Les seuls éditeurs de code autorisés en SE203 sont : vi et clones emacs et clones atom et clones Dans les version graphiques de ces éditeurs, on oubliera les menus et icônes. 12 février 2019 © Alexis Polti SE203 page 6 Stockage et échange d'information Toute production électronique doit être stockée dans git. pas d'échange de code par mail, même pour poser une question au besoin, utiliser les gist ou équivalents Commiter souvent (5 minutes max), pusher aussi souvent un code n'a pas besoin d'être terminé pour être commité : WIP si vous souhaitez un historique « propre » faites des branches Ne jamais travailler directement dans son dépôt git : travail : dans un répertoire à côté copie des fichiers dans le dépôt git quand c'est dans un état montrable commit / push 12 février 2019 © Alexis Polti SE203 page 7 Stockage et échange d'information Toute production électronique doit être stockée dans git. pas d'échange de code par mail, même pour poser une question au besoin, utiliser les gist ou équivalents Commiter souvent (5 minutes max), pusher aussi souvent un code n'a pas besoin d'être terminé pour être commité : WIP si vous souhaitez un historique « propre » faites des branches Ne jamais travailler directement dans son dépôt git : travail : dans un répertoire à côté copie des fichiers dans le dépôt git quand c'est dans un état montrable commit / push Ça va pas non ??? 12 février 2019 © Alexis Polti SE203 page 8 Stockage et échange d'information Les fichiers seront au format texte pur, sauf impossibilité absolue (image, binaire, …) Les fichiers seront encodés en UTF8 sans BOM file fichier pour connaître son encodage iconv ou recode pour changer l'encodage Pas de fichier inutile dans le dépôt utilisez le .gitignore Les messages de commit doivent être clairs et explicites résumé en première ligne au besoin, plus d'infos sur les lignes suivantes 12 février 2019 © Alexis Polti SE203 page 9 Et surtout... Prenez le temps d'apprendre. La magie noire n'existe pas : chaque ligne écrite doit être comprise. Par défaut tout va bien. Si ce n'est pas le cas, dites-le / posez des questions. Vous serez notés sur votre interaction avec nous. 12 février 2019 © Alexis Polti SE203 page 10 Et surtout... 12 février 2019 © Alexis Polti SE203 page 11 WTF ??? 12 février 2019 © Alexis Polti SE203 page 12 Hmmm… 12 février 2019 © Alexis Polti SE203 page 13 Tiens, du code inexistant ! > cat code.c > cat t.c 12 février 2019 © Alexis Polti SE203 page 14 Un PNG ? Sérieusement ??? > ls exercice2 heap-stack.png test.c > gimp heap-stack.png 12 février 2019 © Alexis Polti SE203 page 15 Suivre des consignes simples… 12 février 2019 © Alexis Polti SE203 page 16 Nooooooooooooon ! 12 février 2019 © Alexis Polti SE203 page 17 Aaaaahhhhhhh c'est une conspiration ! uploads/S4/ 0-bonnes-pratiques.pdf