diff --git a/doc/faq-contributing.xml b/doc/faq-contributing.xml index b2315a09ba7505cecf7d84a57f39b88cb865b370..66824ee9dbced12b1aae591ef7f5550c1bcce0f8 100644 --- a/doc/faq-contributing.xml +++ b/doc/faq-contributing.xml @@ -163,6 +163,13 @@ the source file StringPool.cpp.</li> <li>In general, code should be documented with comments. Use JavaDoc tags to describe methods.</li> + + <li>The naming convention for ENUMS should be choosen to be unique and descriptive + (i.e. INVALID or UNKNOWN) to avoid colliding with predefined macros in other + products. The current style of using ALL CAP enums should be phased out with + Mixed Case instead, except for names specified in standards (for example, TEXT_NODE + should not be converted to mixed case for standards compliance).</li> + </ol> </a> </faq>