OsrsBot icon indicating copy to clipboard operation
OsrsBot copied to clipboard

[REVIEW] Clean-up Code

Open GigiaJ opened this issue 4 years ago • 5 comments

Code contains remnants of the massively overhauled code base used to create this. Most of it has been changed and should be updated to reflect said change. Such changes would include updating comments, class descriptors, variable names, and removing remnant features that are no longer applicable or prepping them for a conversion.

GigiaJ avatar Mar 26 '20 21:03 GigiaJ

Think you should avoid using the term "bot", maybe rename it to RSB. also on the github description too would help being discreet because jagex staff doesn't like this stuff.

f0rmatme avatar Apr 02 '20 02:04 f0rmatme

Any recommendations there? Also, in code references too? I can actually shift quite a bit of references to the word bot to runeLite or RSB if necessary. I've been thinking the project could also use a disclaimer of sorts, but am not certain where to begin there either. I'd love to get your insight. :)

GigiaJ avatar Apr 02 '20 17:04 GigiaJ

Just avoid using the term and ya a disclaimer wouldn't hurt. yeah i would do code references too

f0rmatme avatar Apr 03 '20 01:04 f0rmatme

Alright, I'll work towards making those changes and adding a disclaimer! Thanks. I'll be keeping this open as some other changes I'd like to mention is removing commented out code, adding comments to explain functions, revising existing comments, and probably some more.

As always thanks a bunch!

GigiaJ avatar Apr 03 '20 04:04 GigiaJ

Hello, I see that for a lot of wiki docs we refer to https://github.com/OSRSB/RSB; however, the current repo URL is https://github.com/OSRSB/OsrsBot. Does GitHub allow for renaming of repos? If we should be removing "bot" from the repo, should we look at renaming the repo (and therefore the links in the docs)?

I understand that this ticket is pretty old, might want to create a new issue for this decision.

millettmb avatar May 10 '22 09:05 millettmb