diasurgical/devilutionX

Refactor devilution.DefaultClass::CheckCursMove()

Open

#1,995 opened on May 17, 2021

View on GitHub
 (2 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 devilution.DefaultClass::CheckCursMove() for refactoring, which is a unit of 421 lines of code. Addressing this will make our codebase more maintainable and improve Better Code Hub's Write Short Units of Code guideline rating! 👍

Here's the gist of this guideline:

  • Definition 📖 Limit the length of code units to 15 lines of code.
  • Why❓ Small units are easier to analyse, test and reuse.
  • How 🔧 When writing new units, don't let them grow above 15 lines of code. When a unit grows beyond this, split it in smaller units of no longer than 15 lines.

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

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

Contributor guide

Research direction
Examine the CheckCursMove() function in Source/cursor.cpp from line 244 to 692 and refactor it into smaller units of no more than 15 lines each, ensuring the logic is preserved.
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
GitC++
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70