Project-Poseidon icon indicating copy to clipboard operation
Project-Poseidon copied to clipboard

Inconsistent change markers.

Open gibsonpil opened this issue 11 months ago • 1 comments

When code outside of Project Poseidon's classes is changed (such as org.bukkit and NMS code), typically the changes are marked by comments showing where the changes start and begin. Unfortunately, in many areas that were modified by Poseidon, comments of this type were not added (particularly where visibility modifiers are changed). Further, they are often added in different variations and formats since a specific variation is not specified by the project.

I have found that this can make working on Project Poseidon very confusing.

I propose some kind of a guide (think the CONTRIBUTING.MD file present in many projects) is added to Project Poseidon and markers are required in the future. I think that Bukkit's old contribution guide would be a sensible starting point.

Older modifications could be tracked down and have markers retroactively added to them by DIFFing the project and the original CB1060 source it forked from.

Let me know what you guys think.

gibsonpil avatar Jan 15 '25 20:01 gibsonpil

I’m open to pull requests that add markers to the Poseidon code.

I’ll also add creating a CONTRIBUTING.md document to my to-do list. However, if someone is able to tackle this before I get to it, I’m happy to review and accept pull requests for that as well.

RhysB avatar Jan 24 '25 22:01 RhysB