Skip to content

Rename all TODOs to HACKERSM64_DO - #927

Open
gheskett wants to merge 4 commits into
HackerN64:develop/2.4.0from
gheskett:rename-todos
Open

Rename all TODOs to HACKERSM64_DO#927
gheskett wants to merge 4 commits into
HackerN64:develop/2.4.0from
gheskett:rename-todos

Conversation

@gheskett

@gheskett gheskett commented Jan 21, 2026

Copy link
Copy Markdown
Collaborator

The TODO keyword should really be reserved for actual ROM hackers, as most of them probably couldn't care less about any HackerSM64 or decomp tech debt. Searchability for the TODO keyword should now be uninhibited by former TODOs, as they now read HACKERSM64_DO.

The TODO keyword should really be reserved for actual ROM hackers, as most of them probably couldn't care less about any HackerSM64 or decomp tech debt. Searchability for the TODO keyword, as well as HACKERSM64_DO and DECOMP_DO should also be a lot easier now, with fewer irrelevant results.
@gheskett gheskett added this to the 2.4 milestone Jan 21, 2026
@gheskett gheskett self-assigned this Jan 21, 2026
@gheskett gheskett added the documentation Improvements or additions to documentation label Jan 21, 2026
@gheskett gheskett added the cleanup Removal of useless or bloat code/features label Jan 21, 2026
@arthurtilly

Copy link
Copy Markdown
Collaborator

wait you guys unironically search for the TODO comments that you left? i thought it was a bit

@gheskett

Copy link
Copy Markdown
Collaborator Author

Believe it or not, yes (especially in hacks)

@arthurtilly

Copy link
Copy Markdown
Collaborator

don't agree with this one

@gheskett

gheskett commented Aug 29, 2026

Copy link
Copy Markdown
Collaborator Author

What do you propose instead? I really do not want to leave messy TODOs in this repo (particularly not ones that obfuscate search results and standardized syntax highlighting)

@arthurtilly

Copy link
Copy Markdown
Collaborator

First of all I don't think that there's any point in distinguishing between base decomp vs hackersm64 todos - decomp is not in development anymore, so either we decide if we want to do those todos ourselves, making them a hackersm64 todo, or we just delete them. Second this would just encourage us to never address the todos. Regardless its not a blocker for 2.4

@arthurtilly

Copy link
Copy Markdown
Collaborator

But mainly I just think this introduces potential merge conflicts for upgrades for no good benefit/reason which I dont like

@gheskett

Copy link
Copy Markdown
Collaborator Author

Deleting the comments would also create conflicts, but none of them are of any difficulty to fix. I would be open to deleting most of the decomp ones since yeah I agree irrelevant, but I think it's worth keeping some hacker ones in some manner. Either way though I still want those TODOs gone since it's a hindrance for people that actually use that keyword (most programmers)

@arthurtilly

Copy link
Copy Markdown
Collaborator

i think you heavily overestimate the number of people who actively use todo and also expect it to be easily searchable. i mean we clearly don't even do that, and we're the ones leaving the todos

@LucretiaArc

Copy link
Copy Markdown
Collaborator

For what it's worth, this has frustrated me before. Freeing up TODO for child projects would be nice for those that would use it. I don't think Arctic is overestimating the use of TODO as a keyword, seeing as it's commonly given its own syntax highlighting rules in code editors/IDEs.

@gheskett

gheskett commented Aug 29, 2026

Copy link
Copy Markdown
Collaborator Author

Yeah us not addressing the TODOs isn't because they're useless, it's because we're lazy lol (although the repo being 90% decomp TODOs doesn't help either)

@gheskett gheskett changed the title Rename all TODOs to DECOMP_DO and HACKERSM64_DO Rename all TODOs to HACKERSM64_DO Sep 1, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

cleanup Removal of useless or bloat code/features documentation Improvements or additions to documentation

Projects

Status: Needs Review

Development

Successfully merging this pull request may close these issues.

3 participants