Skip to content

Update Contributing.rst #5915

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ab9rf merged 1 commit into from
Sep 16, 2026
+5 −0
Merged

Update Contributing.rst #5915

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions docs/dev/Contributing.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
---------------------------
Expand Down
Loading