mirror of
https://github.com/LizardByte/Sunshine.git
synced 2026-08-07 10:20:46 +00:00
docs(contributing): refresh clang-format guidance (#5233)
This commit is contained in:
+5
-11
@@ -17,7 +17,7 @@ Read our contribution guide in our organization level
|
||||
(check `template_header.html` and `template_header_main.html`).
|
||||
* The Style System is provided by [Bootstrap](https://getbootstrap.com).
|
||||
* Icons are provided by [Lucide](https://lucide.dev) and [Simple Icons](https://simpleicons.org).
|
||||
* The JS framework used by the more interactive pages is [Vus.js](https://vuejs.org).
|
||||
* The JS framework used by the more interactive pages is [Vue.js](https://vuejs.org).
|
||||
|
||||
#### Building
|
||||
|
||||
@@ -39,7 +39,7 @@ The default language is `en` (English).
|
||||
|
||||
@admonition{Community | We are looking for language coordinators to help approve translations.
|
||||
The goal is to have the bars above filled with green!
|
||||
If you are interesting, please reach out to us on our Discord server.}
|
||||
If you are interested, please reach out to us on our Discord server.}
|
||||
|
||||
#### CrowdIn
|
||||
The translations occur on [CrowdIn][crowdin-url].
|
||||
@@ -156,17 +156,11 @@ Additionally, [xgettext](https://www.gnu.org/software/gettext) must be installed
|
||||
### Testing
|
||||
|
||||
#### Clang Format
|
||||
Source code is tested against the `.clang-format` file for linting errors. The workflow file responsible for clang
|
||||
format testing is `.github/workflows/cpp-clang-format-lint.yml`.
|
||||
Source code is tested against the `.clang-format` file for linting errors.
|
||||
|
||||
Option 1:
|
||||
To apply clang-format locally (will modify files):
|
||||
```bash
|
||||
find ./ -iname *.cpp -o -iname *.h -iname *.m -iname *.mm | xargs clang-format -i
|
||||
```
|
||||
|
||||
Option 2 (will modify files):
|
||||
```bash
|
||||
uv run --only-group lint python ./scripts/update_clang_format.py
|
||||
uv run --no-sync --only-group lint python ./scripts/update_clang_format.py
|
||||
```
|
||||
|
||||
#### Unit Testing
|
||||
|
||||
Reference in New Issue
Block a user