smells
1.0.0
Un catalogue en ligne complet
Visitez le site Web · Préprint · Springer Paper · La thèseCe référentiel contient la source du site Web du catalogue des odeurs de code qui contient la liste actuelle des odeurs avec leur:
N'hésitez pas à visiter le site Web et à parcourir!
Si vous souhaitez gratter les données, clonez le référentiel et exécutez python /data_scraper/main.py .
Tout le monde
Les nouveaux développeurs peuvent parcourir la liste des odeurs de code sous une forme agréable et lisible d'articles et les lire pour obtenir une bonne intuition de ce qui pourrait être une mauvaise pratique ou ce qu'ils devraient surveiller.
Ils peuvent trouver les descriptions des odeurs, leur exemple de causalité potentiel et les attributs à l'abstraction au format de table et à la table sur l'odeur de code particulière (comme si c'était une odeur qui se produit dans une classe ou entre les classes). En plus de cela - la majorité des odeurs de code ont des exemples qui sont souvent très importants lorsque l'on apprend une nouvelle chose.
Il est beaucoup plus facile de gérer une discussion sur la révision du code lorsque quelqu'un peut placer un lien directement à la source de ses préoccupations. Cela pourrait profiter et accélérer la compréhension de l'odeur du code parmi les développeurs.
Une grande proportion de développeurs peut même connaître intuitivement la plupart de ces choses sans connaître le problème lui-même comme un phénomène nommé. Ceci peut encore une fois améliorer les compétences globales des développeurs.
Les données et les informations sur les odeurs sont dispersées et il est difficile de collecter toutes les odeurs pour exécuter de manière holistique des recherches sur eux. Actuellement, à partir de 2022, les données recherchées sur différentes odeurs sont radicalement disproportionnées. Certaines odeurs de code sont presque toujours prises en compte, certaines rarement, et certaines ne sont pas du tout couvertes par la recherche - soit parce qu'elles ont été perdues dans le bruit de l'information, soit parce qu'elles ne se sont jamais produites avec le mot-clé approprié.
Ce catalogue est conçu pour unifier les données disponibles et normaliser la nomenclature (synonymes) et les différentes perspectives (taxonomies) à partir desquelles ce problème peut être examiné.
Si vous souhaitez contribuer, vous êtes plus que bienvenu en ouvrant une nouvelle discussion dans les problèmes ou en ajoutant directement des modifications en ouvrant de nouvelles demandes de fusion. Je soupçonne qu'il pourrait y avoir des discussions en cours (je suis profondément convaincu que dans un si énorme tas de choses, j'ai dû faire des erreurs, même statistiquement parlant) . ?
Ceci est censé être aussi simple que possible pour tout le monde de contribuer du côté théorique - pas besoin de connaître des langages de programmation, car le contenu du site Web peut être géré par des fichiers de type Markdown dans le répertoire content . Le contenu est dans un format markdown standard et les données clés de l'en-tête de fichier Markdown au format YAML .
