Compare commits

..

2 commits

Author SHA1 Message Date
Judah Caruso
c8c82d0000 update STYLEGUIDE 2025-05-21 22:05:43 -06:00
Judah Caruso
9ad7b07bc6 default to static linking for raylib 2025-05-21 22:05:34 -06:00
2 changed files with 55 additions and 16 deletions

View file

@ -2,10 +2,7 @@
Style Guide
-----------
This document serves as a loose style guide for the repo.
Generally, you should write code that follows the local
style of the file you're in, however, there are a few
conventions to keep in mind.
This document outlines repo conventions and code style.
Getting Paid
@ -40,6 +37,31 @@ message should only say 'finish [id]'.
finish 034
Code Style
----------
Generally, I don't care what style of code is used. It's
more important that you stay in line with the local style
of the file you're in.
Things I actually care about:
- Don't be clever. Write code that does the job;
nothing more, nothing less.
- Comment your code. I very much disagree with the
premise that code is self-documenting. Take a step
back and write a comment (with your name) that
explains *why* you're doing *what* you're doing.
Please try to stick to this format:
@note, @todo, @temp, @allocates, @leak
- Descriptive names. In general, it's fine to use short
names for local variables. However, you should
almost always opt for longer, more descriptive names
in every other context.
Imports
-------
@ -81,6 +103,23 @@ When authoring a new module, use this as a base plate:
}
Bindings
--------
Binding modules should default to static linking and take
an optional '#module_parameter' to link dynamically.
Libraries should be pinned to a specific version, and all
binaries (.dll, .dylib, etc.) *must* be checked into
source control. If possible, use the release build of the
library that includes debug information.
Bindings should stay as close as possible to the original
library. To jai-ify the bindings, create a submodule
called 'wrapper' that import and wraps the api.
See: 'thirdparty/raylib' for example bindings.
OS-Specific Code
----------------

View file

@ -1,4 +1,4 @@
#module_parameters(STATIC := false);
#module_parameters(STATIC := true);
#scope_export