sotn-decomp icon indicating copy to clipboard operation
sotn-decomp copied to clipboard

Delete docs/STYLE.md

Open Xeeynamo opened this issue 9 months ago • 3 comments

Not needed any more. Styling has been consolidated and existing code can be used as a style reference. This guide was old and did not fully conform to our code base. Most of the styling is fixed by the formatter anyway.

Xeeynamo avatar Mar 23 '25 13:03 Xeeynamo

So are we just ignoring style now? Like no PR reviews like this? https://github.com/Xeeynamo/sotn-decomp/pull/2350#discussion_r2008896099

sozud avatar Mar 23 '25 17:03 sozud

So are we just ignoring style now? Like no PR reviews like this? #2350 (comment)

I think it is better to have no style document than an incomplete or wrong one. I read multiple times contributors were misguided by old conventions. #2350 proves the style guide is not a bullet-proof. If we see a degradation in the proposed PRs (I do not expect that to happen from existing contributors), we can propose a new one.

Xeeynamo avatar Mar 23 '25 18:03 Xeeynamo

Having some baseline style enforcement is important IMO, otherwise someone will need to do all that cleanup down the line. There are things like function/variable/macro naming and bool over 1/0 that are fairly easy to decide and enforce. I think requiring these things and continuing to require make format be run would go a long way toward styling without being opinion based.

The way I see it is that it's the subjective styling points that get really murky and don't really contribute much to overall code quality, so my suggestion is to trim down the style guide and instead call it "PR guidelines" or something like that.

I could put together an example of what I mean on the wiki if you want me to.

To be clear, I don't consider this to be for "keeping people honest", so to speak. I see it instead for helping newcomers know what to expect and for those of us (I'm one of them) who like having a reference instead of trusting to their memory.

ProjectOblivion avatar Mar 24 '25 20:03 ProjectOblivion

Sure. I will close this then and come up later with some refinements instead.

Xeeynamo avatar Mar 29 '25 12:03 Xeeynamo