docs: clarify clang-format version and usage (#474)

* docs: clarify clang-format version and usage

Added version, installation, and verification steps for clang-format to help contributors avoid CI issues.

* Enhance CONTRIBUTING.md with installation details

Updated installation instructions for clang-format on Ubuntu/Debian and Arch Linux. Added details for verifying installation and modified commands to include additional directories.

* Revise clang-format installation instructions

Updated installation instructions for clang-format and removed redundant verification section.

* Enhance clang-format usage instructions in CONTRIBUTING.md

Added recommendations for using clang-format before PR submission to ensure proper code formatting.

* Update CONTRIBUTING.md with clang18 PATH instructions

Add instructions to set PATH for clang18 on Arch Linux
This commit is contained in:
HEMASHREE N
2026-05-10 16:00:32 -07:00
committed by GitHub
parent a79c4c92e2
commit 57ec84fcc7
+43 -2
View File
@@ -41,6 +41,45 @@ Running `clang-format` locally is recommended before submitting a PR as it will
Either way, just ensure you manually review automatic changes. Either way, just ensure you manually review automatic changes.
### Version
This project currently uses **clang-format version 18**.
Please ensure you are using this version to avoid CI formatting failures.
### Installation
<details>
<summary>Install on Ubuntu / Debian</summary>
```bash
sudo apt install clang-format
```
</details>
<details>
<summary>Install on Arch Linux</summary>
```bash
sudo pacman -S clang18
# Add to PATH via 'profile.d'
echo 'export PATH="/usr/lib/llvm18/bin:${PATH}"' | sudo tee /etc/profile.d/clang-format-18.sh
```
</details>
### Verify Installation
You can check your installed version using:
```bash
clang-format --version
```
Ensure the output shows version 18.
#### VSCode #### VSCode
The recommended setup for VSCode is to install the [**clangd**](https://marketplace.visualstudio.com/items?itemName=llvm-vs-code-extensions.vscode-clangd) extension. It will provide helpful information in VSCode and can be used to format the code automatically according to the `.clang-format` file with **`Ctrl+Shift+I`** The recommended setup for VSCode is to install the [**clangd**](https://marketplace.visualstudio.com/items?itemName=llvm-vs-code-extensions.vscode-clangd) extension. It will provide helpful information in VSCode and can be used to format the code automatically according to the `.clang-format` file with **`Ctrl+Shift+I`**
@@ -53,9 +92,11 @@ If installed locally and you'd prefer to use it in your shell. You can do the fo
```sh ```sh
# List warnings # List warnings
clang-format --dry-run -Werror include/*.h source/*.c clang-format --dry-run -Werror include/*.h include/game/*.h source/*.c source/game/*.c
# Modify all files inplace # Modify all files inplace
clang-format -i include/*.h source/*.c clang-format -i include/*.h include/game/*.h source/*.c source/game/*.c
# Or just one # Or just one
clang-format -i include/blind.h clang-format -i include/blind.h
``` ```