From 15756cc73030e703f0ac03b7909110ed2267fed0 Mon Sep 17 00:00:00 2001 From: Bob Andrews Date: Thu, 28 Jul 2022 00:29:05 +0200 Subject: [PATCH] Update Contributing.md --- Contributing.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/Contributing.md b/Contributing.md index 5861a9c2e..71d7dc3a2 100644 --- a/Contributing.md +++ b/Contributing.md @@ -24,6 +24,10 @@ This is an ongoing controversial topic - everyone knows that. However, the follo The (bash) scripts used to check the above rules can be found in ```.github/check```. You can also run all checks using ```make check```. +### identifiers and symbol names + +* any symbols that are exported from source files and/or appear in header files should not be in the "_symbol" form in C, or "__symbol" form in assembly. This way we evade the problem that "_symbol" may or may not be reserved by that standard. + ### misc * 80 characters is the desired maximum width of files. But, it isn't a "strong" rule; sometimes, you will want to type longer lines, in order to keep the parts of expressions or comments together on the same line.