Update formatting guidelines

Signed-off-by: TheKodeToad <TheKodeToad@proton.me>
This commit is contained in:
TheKodeToad 2024-11-06 15:56:10 +00:00
parent 1ab10bdd84
commit b67d400f60
No known key found for this signature in database
GPG Key ID: 5E39D70B4C93C38E

View File

@ -2,16 +2,54 @@
## Code formatting ## Code formatting
Try to follow the existing formatting. All files are formatted with `clang-format` using the configuration in `.clang-format`. Ensure it is run on changed files before committing!
If there is no existing formatting, you may use `clang-format` with our included `.clang-format` configuration.
In general, in order of importance: We have no tool for enforcing names but please follow the following conventions for C++:
- Class and type names should be formatted as `PascalCase`: `MyClass`.
- Private, non-`static const` class data members should be formatted as `camelCase` prefixed with `m_`: `m_myCounter`.
- Public, non-`static const` should be the same but without the prefix: `dateOfBirth`.
- Class function members should be formatted as `camelCase` without a prefix: `incrementCounter`.
- Non-`const` global variables should be formatted as `camelCase` without a prefix: `globalData`. And, of course, should be avoided where possible.
- `const` global variables, `static const` class data members, macros, and enum constants should be formatted as `SCREAMING_SNAKE_CASE`: `LIGHT_GRAY`.
- Avoid inventing acronyms or abbreviations especially for a name of multiple words - like `tp` for `texturePack`.
- Make sure your IDE is not messing up line endings or whitespace and avoid using linters. Here is what these conventions with the formatting configuration look like:
- Prefer readability over dogma.
- Keep to the existing formatting. ```c++
- Indent with 4 space unless it's in a submodule. #define AWESOMENESS 10
- Keep lists (of arguments, parameters, initializers...) as lists, not paragraphs. It should either read from top to bottom, or left to right. Not both.
constexpr double PI = 3.14159;
enum class PizzaToppings { HAM_AND_PINEAPPLE, OREO_AND_KETCHUP };
struct Person {
QString name;
QDateTime dateOfBirth;
long daysOld() const { return dateOfBirth.daysTo(QDateTime::currentDateTime()); }
};
class ImportantClass {
public:
void incrementCounter()
{
if (m_counter + 1 > MAX_COUNTER_VALUE)
throw std::runtime_error("Counter has reached limit!");
++m_counter;
}
int counter() const { return m_counter; }
private:
static constexpr int MAX_COUNTER_VALUE = 100;
int m_counter;
};
ImportantClass importantClassInstance;
```
If you see any names which do not follow these conventions, it is preferred that you leave them be - renames increase the number of changes therefore make reviewing harder and make your PR more prone to conflicts. However, if you're refactoring a whole class anyway, it's fine.
## Signing your work ## Signing your work