From 9cbcc7c95aaa0fa5c5f9dc75878cfc5847e65b3d Mon Sep 17 00:00:00 2001 From: Patrick J Cherry Date: Tue, 20 Feb 2018 11:05:36 +0000 Subject: [PATCH] Added note about the test file formatting --- CONTRIBUTING.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f53854e..d52ffb0 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,3 +1,24 @@ # Contribution guide The code is formatted using the K&R style of "indent". + +``` +indent -kr +``` + +The C unit tests have also been indented in the same way, but manually adjsted +such that the functions follow the normal libcheck layout. + +```c +START_TEST( ... ) { + + +} +END TEST +``` + +Indent tends to mangle the `END_TEST` macro, so that will need adjusting if +`indent` is run over the test files again. + + +