Skip to content

Commit

Permalink
bullet typo
Browse files Browse the repository at this point in the history
  • Loading branch information
agl-alexglopez committed Nov 22, 2024
1 parent 706ca93 commit 15cd995
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,10 +22,10 @@ Here is a description of the current repository organization.
Required tools:

- [pre-commit](https://pre-commit.com/) - Run `pre-commit install` once the repo is forked/cloned. This will ensure pointless formatting changes don't enter the commit history.
- [clang-format] - This is needed less so now that `pre-commit` helps with formatting.
- [clangd] - This is helpful for your editor if you have a `LSP` that can auto-format on save. This repo has both a `.clang-tidy` and `.clang-format` file that help `LSP`'s and other tools with warnings while you write.
- [clang-tidy] - Clang tidy should be run often on any changes to the code to catch obvious errors.
- [gcc-14+] - GCC 14 onward added excellent `-fanalyzer` capabilities. There are GCC presets in `CMakePresets.json` to run `-fanalyzer` and numerous sanitizers. These work best with newer GCC versions.
- clang-format - This is needed less so now that `pre-commit` helps with formatting.
- clangd - This is helpful for your editor if you have a `LSP` that can auto-format on save. This repo has both a `.clang-tidy` and `.clang-format` file that help `LSP`'s and other tools with warnings while you write.
- clang-tidy - Clang tidy should be run often on any changes to the code to catch obvious errors.
- gcc-14+ - GCC 14 onward added excellent `-fanalyzer` capabilities. There are GCC presets in `CMakePresets.json` to run `-fanalyzer` and numerous sanitizers. These work best with newer GCC versions.

Add a `CMakeUserPresets.json` file so that you can run the sanitizer presets found in `CMakePresets.json`. Here is my setup as a sample.

Expand Down

0 comments on commit 15cd995

Please sign in to comment.