mirror/tww
1
0
Fork 0
mirror of https://github.com/zeldaret/tww.git synced 2026-08-24 15:07:18 -04:00
Code Issues Packages Projects Releases Wiki Activity

Add CONTRIBUTING.md, update coding guidelines

Browse Source
This commit is contained in:
LagoLunatic
2026-08-23 14:29:44 -04:00
parent 85047b9356
commit 4caa5d8fc4
4 changed files with 29 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/decompiling.md
+3 -1
View File
@@ -4,6 +4,8 @@ This document describes the basics how to start decompiling code and contributin
If you haven't already, you should first follow the instructions in the [readme](../README.md) to get the decomp set up, as well as the tools you will be using to work on it: objdiff and Ghidra.
You should also read the [coding guidelines page](coding_guidelines.md) page to ensure that the code you write is clear and readable.
## Table of Contents
1. [Choosing an object to decompile](#choosing-an-object-to-decompile)
@@ -689,4 +691,4 @@ Then you can just submit a pull request as-is instead of worrying about it any m
Once an actor is fully decompiled, you can start naming some of its member variables if you want to. This is completely optional - it's normal to submit a PR without documenting most fields. Leaving them unnamed (e.g. `field_0x290`) is preferable to coming up with wrong names if you aren't sure.
But if you do decide to start naming things, you should check out the [coding guidelines page](coding_guidelines.md).
But if you do decide to start naming things, you should check out the ['Naming style' section of the coding guidelines page](coding_guidelines.md#naming-style).