Commit 6c3f6e4c authored by Andrei Muresan's avatar Andrei Muresan
Browse files

hotfix -- fix README headings

parent 1f219378
Pipeline #28240 passed with stages
in 52 seconds
......@@ -10,13 +10,13 @@ Refer to the [Docker](#docker) section below for instructions on setting up and
# Code Style
### C++
## C++
This project integrates with `clang-format` to ensure that the source code adheres to the [LLVM Coding Standards](https://llvm.org/docs/CodingStandards.html) for C++.
Install `clang-format` locally via Homebrew (MacOS) or your preferred package manager. Run `make lint` to detect any style errors, or just run `make format` before making a commit to let the tool automatically format your code. The CI pipeline running for every commit will reject code that does not pass the linting step, ensuring that all of the code merged to the `master` branch follows the standard style.
### Scripts
## Scripts
Shell scripts located under the `scripts/` directory are also linted with [Shellcheck](https://github.com/koalaman/shellcheck), which catches all kinds of mistakes that may cause unexpected issues. You may check your scripts locally using `make shellcheck` (assuming Shellcheck is installed), or via its [web client](https://www.shellcheck.net/).
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment