From 72754ae402167e02760fb606eb17f728565d0481 Mon Sep 17 00:00:00 2001 From: Kelly Kinkade Date: Tue, 15 Sep 2026 16:41:10 -0500 Subject: [PATCH] Update Contributing.rst --- docs/dev/Contributing.rst | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/docs/dev/Contributing.rst b/docs/dev/Contributing.rst index 216d204969..e9600bbce9 100644 --- a/docs/dev/Contributing.rst +++ b/docs/dev/Contributing.rst @@ -60,6 +60,11 @@ Code format * Braces placed at original indent level if on their own lines * ``#include`` directives should be sorted: C++ libraries first, then DFHack modules, then ``df/`` headers, then local includes. Within each category they should be sorted alphabetically. + * Avoid naming a type with a name that ends in ``st`` unless the structure is being named intentionally the same as a structure in Dwarf Fortress. If you are defining a new structure, avoid using a name that ends in ``st`` to avoid any risk of confusion. + +* For Lua: + + * Identifiers for publicly visible functions and variables should be in ``camelCase``. General C++ code guidelines ---------------------------