diasurgical/DevilutionX

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

Offen

#1.996 geöffnet am 17.05.2021

Auf GitHub ansehenContributor Guide
 (1 Kommentar) (0 Reaktionen) (0 zugewiesene Personen)C++ (743 Forks)batch import
good first issuehelp wanted

Repository-Metriken

Stars
 (7.255 Sterne)
PR-Merge-Metriken
 (Durchschn. Merge 2T 12h) (15 gemergte PRs in 30 T)

Beschreibung

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:

Contributor Guide

Research-Richtung
Finden Sie den großen Switch in CheckInvPaste und extrahieren Sie jeden Fall in eine separate Funktion. Rufen Sie dann diese Funktionen vom Switch aus auf.
Tech Stack
cpp
Domain
game dev
Issue Type
Refactoring
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
3
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-2 Tage
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
C++
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
55