TheOpenSpaceProgram / osp-magnum

A spaceship game
https://www.openspaceprogram.org/
MIT License
216 stars 32 forks source link

Add new Documentation: architecture.md and guidelines.md #273

Closed Capital-Asterisk closed 6 months ago

Capital-Asterisk commented 6 months ago

docs. Docs. DOCS!!!

I might add things to architecture, otherwise this is mostly ready to merge.

Ben-Bingham commented 6 months ago

I was just reading through guidlines.md, and couldn't figure this out so I figured I would put this here:

What should be the casing of a variable after an underscore prefix? ie: g_GlobalVariable g_globalVariable

I honestly don't know which one is preferred so figured I would put it here, regardless, it would be helpful to place an additional example that clarifies which style is preferred on line 148ish of guidlines.md

jonesmz commented 6 months ago

There's also this style guide document that I wrote. Not sure how far diverged you've gotten from it: https://docs.google.com/document/d/1dJW-E6SN41XQuvidHRhp41O_1mJmP90bar1egZ31c10/edit?usp=sharing

jonesmz commented 6 months ago

and in general all the docs here probably need overhauled: https://drive.google.com/drive/folders/1zSpXs7tiBI3XmGx9dwlHiqxjRaB997lC?usp=drive_link

jonesmz commented 6 months ago

I was just reading through guidlines.md, and couldn't figure this out so I figured I would put this here:

What should be the casing of a variable after an underscore prefix? ie: g_GlobalVariable g_globalVariable

I honestly don't know which one is preferred so figured I would put it here, regardless, it would be helpful to place an additional example that clarifies which style is preferred on line 148ish of guidlines.md

camelCase generally has the first letter lowercased.

g_ is the prefix, globalVariable would be the "word", so lowercase the first letter of the word.

Capital-Asterisk commented 6 months ago

I was just reading through guidlines.md, and couldn't figure this out so I figured I would put this here: What should be the casing of a variable after an underscore prefix? ie: g_GlobalVariable g_globalVariable I honestly don't know which one is preferred so figured I would put it here, regardless, it would be helpful to place an additional example that clarifies which style is preferred on line 148ish of guidlines.md

camelCase generally has the first letter lowercased.

g_ is the prefix, globalVariable would be the "word", so lowercase the first letter of the word.

I mean, the example is missing. time to push directly to master