diasurgical/devilutionX

Refactor 31 lines occurring 2 times in 2 files: drlg_l2.cpp, drlg_l4.cpp

Open

#1,997 opened on May 17, 2021

View on GitHub
 (6 comments) (0 reactions) (0 assignees)C++ (743 forks)batch import
good first issuehelp wanted

Repository metrics

Stars
 (7,255 stars)
PR merge metrics
 (Avg merge 2d 12h) (15 merged PRs in 30d)

Description

I've selected for refactoring 31 lines of code which are duplicated in 2 file(s) (1, 2). Addressing this will make our codebase more maintainable and improve Better Code Hub's Write Code Once guideline rating! 👍

Here's the gist of this guideline:

  • Definition 📖 Do not copy code.
  • Why❓ When code is copied, bugs need to be fixed in multiple places. This is both inefficient and a source of regression bugs.
  • How 🔧 Avoid duplication by never copy/pasting blocks of code and reduce duplication by extracting shared code, either to a new unit or introduce a superclass if the language permits.

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

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

Contributor guide

Research direction
Compare the duplicated code blocks in drlg l2.cpp and drlg l4.cpp, identify the common logic, and extract it into a new shared function to reduce duplication.
Tech stack
cpp
Domain
game dev
Issue type
Refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
C++
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75