From 951df64a43673d8fc5b8f851fd3fe9b9ea15b0cf Mon Sep 17 00:00:00 2001 From: Michael Vetter Date: Sat, 15 Apr 2023 11:50:57 +0200 Subject: [PATCH] docs: Add info about different clang-format versions Make this clear to new users. Since sjaeckel had reservations on https://github.com/profanity-im/profanity/pull/1828. --- CONTRIBUTING.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index baf999df..7a26b657 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -95,6 +95,8 @@ what may have been staged/committed. If you're in a hurry you can add the `--no-verify` flag when issuing `git push` and the `pre-push` hook will be skipped. +*Note:* We provide a config file that describes our coding style for clang. But due to a mistake on their side it might happen that you can get a different result that what we expect. See [here](https://github.com/profanity-im/profanity/pull/1774) and [here](https://github.com/profanity-im/profanity/pull/1828) for details. We will try to always run latest clang-format. + ## Finding mistakes Test your changes with the following tools to find mistakes.