diasurgical/DevilutionX

Refactor devilution.DefaultClass::CheckInvPaste(int, int, int)

Ouverte

#1 996 ouverte le 17 mai 2021

Voir sur GitHubGuide contributeur
 (1 commentaire) (0 réaction) (0 personne assignée)C++ (743 forks)batch import
good first issuehelp wanted

Métriques du dépôt

Stars
 (7 255 étoiles)
Métriques de merge PR
 (Métriques PR en attente)

Description

I've selected devilution.DefaultClass::CheckInvPaste(int, int, int) for refactoring, which is a unit of 362 lines of code and 135 branch points. Addressing this will make our codebase more maintainable and improve Better Code Hub's Write Simple Units of Code guideline rating! 👍

Here's the gist of this guideline:

  • Definition 📖 Limit the number of branch points (if, for, while, etc.) per unit to 4.
  • Why❓ Keeping the number of branch points low makes units easier to modify and test.
  • How 🔧 Split complex units with a high number of branch points into smaller and simpler ones. This one in particular has a big switch that could probably be split out in to sub-functions.

You can find more info about this guideline in Building Maintainable Software. 📖

Good luck and happy coding! :shipit: :sparkles: :100:

Guide contributeur

Direction de recherche
Identifiez le grand switch dans CheckInvPaste et extrayez chaque cas dans une fonction séparée, puis appelez ces fonctions depuis le switch.
Stack technique
cpp
Domaine
game dev
Type d'issue
Refactorisation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
3
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-2 jours
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
C++
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
55