From 70cc4ca688d5d562ed2ed805e29bd1a2feb31cd1 Mon Sep 17 00:00:00 2001 From: KeybadeBlox Date: Sun, 21 Dec 2025 09:39:55 -0500 Subject: [PATCH] Add stylistic consistency to contribution guide --- contributing.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/contributing.md b/contributing.md index 4675fc1..a68f168 100644 --- a/contributing.md +++ b/contributing.md @@ -243,7 +243,12 @@ correctly (exception-handling code might be appended onto another function, for example). Because `symboltable.tsv` should only be populated with symbols that have been manually defined as per the previous section, this means that you need to define variable names and labels in Ghidra for everything therein (and -ideally everything referenced externally, as well). +ideally everything referenced externally, as well). Do try to maintain basic +consistency with the rest of the codebase: functions and methods begin with +lowercase letters, for instance, while class/struct/enum names begin with +capital letters, and special methods like constructors and destructors should +have the names they would have in real C++ code (i.e. `Class::Class` and +`Class::~Class`, respectively). Once an object is ready for extracting, its `Delink?` column should be set to `true` and the `objdiff.json` file in the `decompile/` directory should be