C code style guide

[dwhinham]

We should come up with or pick a commonly-used code style guide to stick to throughout the project, which defines things such as (but not limited to):

• Tabs (and tab-stop width) vs spaces
  • Currently using tabs with tabstop of 4
• snake_case vs CamelCase
  • _Currently using snakecase in the style of oldschool C
• Variable names
  • Descriptive, but not loo long
• Function names
  • _To avoid naming conflicts with any external code we might bring in, I like the idea of projectname_modulename_functionname(), e.g. pt1210_file_open()_
• Braces (first brace dropped-down vs first brace in-line)
  • Currently dropping down to a new line for the first brace to help clarify where blocks start/end
• Ensuring trailing whitespace is never present
  • Editors can be configured to auto-strip trailing whitespace

We can also employ tools such as clang-tidy to automatically detect when we stray from these and automatically fix them.

Editorconfig a nice tool which is built into many editors or available as an extension which reads an .editorconfig file and sets up things like indentation automatically.

[djh0ffman]

as I've never worked on clang project before, happy to work with whatever you feel is best.

one thing however is the ASM, it needs the indenting cleaning up, but I think we tackle that when we know what is left.

[dwhinham]

That should be a nice easy task with Tat's VSCode extension 😄

[kikendo]

You'll have to bear with me here as the non-coder-that-codes, I might stray from all these conventions until I get used to them.

I just plonk code in and make sure it works haha. Formatting is usually whatever I find readable, and I never really collaborated with anyone like this before, so... Sorry in advance! Feel free to yell at me until I get it.