zdoom/fluidsynth
0
0
Fork 0
mirror of https://github.com/ZDoom/fluidsynth.git synced 2025-04-08 00:31:11 +00:00
Code Issues Projects Releases Packages Wiki Activity

add style guide related notes to CONTRIBUTING.md

Browse source 
regarding clang-tidy and clang-format
This commit is contained in:
Tom M 2018-03-24 14:35:52 +01:00 committed by GitHub
parent 4fd56639fa
commit 79971836ee
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 1 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
CONTRIBUTING.md
View file

@ -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