A friendly way to learn the codebase. Because the source was recovered by decompiling, many method bodies still use mechanical local names (num, text, item, flag, jToken, ...) and bare magic numbers.
Task
Pick any not-yet-cleaned method in StonedAges/StonedAges/GameState.cs and:
- rename its local variables to meaningful names (per-method only - never blind find-replace),
- add an XML
<summary>,
- replace magic numbers with named constants where one exists,
- keep behavior identical.
Verify
dotnet build "Stoned Ages.slnx" -c Release must stay 0 errors / 0 warnings, then launch-test (README -> Running).
Reference
StonedAges/StonedAges/GameWindow.cs is the cleaned-up style exemplar.- Full recipe + gotchas: CONTRIBUTING.md.
- ⚠️ Avoid the "giants" (
Update, Render, UpdateInput, InitializeMenu, DialogPopup, ChatMsg, combat) for a first PR - they need sub-block-by-sub-block care.
A friendly way to learn the codebase. Because the source was recovered by decompiling, many method bodies still use mechanical local names (
num,text,item,flag,jToken, ...) and bare magic numbers.Task
Pick any not-yet-cleaned method in
StonedAges/StonedAges/GameState.csand:<summary>,Verify
dotnet build "Stoned Ages.slnx" -c Releasemust stay 0 errors / 0 warnings, then launch-test (README -> Running).Reference
StonedAges/StonedAges/GameWindow.csis the cleaned-up style exemplar.Update,Render,UpdateInput,InitializeMenu,DialogPopup,ChatMsg, combat) for a first PR - they need sub-block-by-sub-block care.