From 1b293a4032dfa87b8eeee5695ebe0c74a2b9a413 Mon Sep 17 00:00:00 2001 From: RincewindsHat <12514511+RincewindsHat@users.noreply.github.com> Date: Tue, 15 Oct 2024 09:33:34 +0200 Subject: Adapted the coding guidelines slightly + typo diff --git a/doc/developer-guidelines.sgml b/doc/developer-guidelines.sgml index 4186ed7..0afa733 100644 --- a/doc/developer-guidelines.sgml +++ b/doc/developer-guidelines.sgml @@ -713,19 +713,18 @@ setup the tests. Run "make test" to run all the tests.
Coding guidelines See GNU - Coding standards for general guidelines. + Coding standards for general guidelines. + Some parts of the guidelines (namely and explicitly the coding style) + are not seen as best practice by us.
C coding - Variables should be declared at the beginning of code blocks and - not inline because of portability with older compilers. - You should use the type "bool" and its values "true" and "false" instead of the "int" type for booleans.
Crediting sources - If you have copied a routine from another source, make sure the licence + If you have copied a routine from another source, make sure the license from your source allows this. Add a comment referencing the ACKNOWLEDGEMENTS file, where you can put more detail about the source. For contributed code, do not add any named credits in the source code -- cgit v0.10-9-g596f