Jump to content

Formatting: Difference between revisions

From Ratpack
No edit summary
added 'constants' formatting entry
Line 7: Line 7:
  - Struct names: Upper Snake Case, append "_t"
  - Struct names: Upper Snake Case, append "_t"
  - Variables: Lower Snake Case
  - Variables: Lower Snake Case
- Constants: Upper Snake Case
  - Files:
  - Files:
     - .c, .h, .txt Lowercase with underscores
     - .c, .h, .txt Lowercase with underscores

Revision as of 15:34, 31 July 2026


2026 07 31

What format do we use to name things?

- Using "/**" then " * " then " */" to write comments
- Method names: Upper Snake Case
- Struct names: Upper Snake Case, append "_t"
- Variables: Lower Snake Case
- Constants: Upper Snake Case
- Files:
    - .c, .h, .txt Lowercase with underscores
    - .txt and .json Upper Camel Case
- Folders: By vibes

Commit formatting:

- https://gist.github.com/qoomon/5dfcdf8eec66a051ecd85625518cfd13
- <type>(<optional scope>): <description>
- Common Types:
    - feat: commits that add or adjust a feature
    - fix
    - refactor
    - style: formatting stuff that does not affect
    - test: stuff to do with unit testing
    - docs
    - build: stuff relating to build frameworks and tools