From 79971836eefbce5bfe42fc83f9e128932ccad495 Mon Sep 17 00:00:00 2001 From: Tom M Date: Sat, 24 Mar 2018 14:35:52 +0100 Subject: [PATCH] add style guide related notes to CONTRIBUTING.md regarding clang-tidy and clang-format --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 033271a0..a6ec5e89 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -20,7 +20,7 @@ Some things that will increase the chance that your pull request or patch is acc ## Style Guide -Find FluidSynth's style guide below. Most of the syntax issues can be automatically applied with `clang-format` and `clang-tidy` using the config files in the repository root. +Find FluidSynth's style guide below. Syntax related issues, like missing braces, will be automatically taken care of when compiling fluidsynth by calling `make` (provided that cmake has found `clang-tidy >= 5.0` on your system). An explicit reformatting can be achieved using `make format` (provided that cmake has found `clang-format` on your system). #### General * Every function should have a short comment explaining it's purpose