dasha_uwu/PrismLauncher
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Add [[nodiscard]] guidelines

Browse source 
Signed-off-by: TheKodeToad <TheKodeToad@proton.me>
This commit is contained in:
TheKodeToad 2025-07-07 20:56:36 +01:00
parent 29d73a474f
commit 6d19984873
No known key found for this signature in database
GPG key ID: 5E39D70B4C93C38E
1 changed files with 6 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

7
CONTRIBUTING.md
View file

@ -1,6 +1,6 @@
# Contributions Guidelines # Contributions Guidelines
## Code formatting ## Code style
All files are formatted with `clang-format` using the configuration in `.clang-format`. Ensure it is run on changed files before committing! All files are formatted with `clang-format` using the configuration in `.clang-format`. Ensure it is run on changed files before committing!
@ -15,6 +15,11 @@ Please also follow the project's conventions for C++:
- Global functions and non-`const` global variables should be formatted as `camelCase` without a prefix: `globalData`. - Global functions and non-`const` global variables should be formatted as `camelCase` without a prefix: `globalData`.
- `const` global variables, macros, and enum constants should be formatted as `SCREAMING_SNAKE_CASE`: `LIGHT_GRAY`. - `const` global variables, 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`. - Avoid inventing acronyms or abbreviations especially for a name of multiple words - like `tp` for `texturePack`.
- Avoid using `[[nodiscard]]` unless ignoring the return value is likely to cause a bug in cases such as:
- A function allocates memory or another resource and the caller needs to clean it up.
- A function has side effects and an error status is returned.
- A function is likely be mistaken for having side effects.
- A plain getter is unlikely to cause confusion and adding `[[nodiscard]]` can create clutter and inconsistency.
Most of these rules are included in the `.clang-tidy` file, so you can run `clang-tidy` to check for any violations. Most of these rules are included in the `.clang-tidy` file, so you can run `clang-tidy` to check for any violations.