Rooba
/
ReC98
mirror of https://github.com/nmlgc/ReC98.git
1
1
Fork 0
Code Issues Packages Projects Releases Wiki Activity

[Contributing] Padding bytes should be rewritten into `even` or `align`

This commit is contained in:
nmlgc 2019-12-24 16:51:43 +01:00
parent f275e041e9
commit 034ae4ba94
1 changed files with 5 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
CONTRIBUTING.md
View File

@ -55,6 +55,11 @@ binary, as compared using [mzdiff].** The only allowed exceptions are:
(Counterexample: Small, insignificant amounts of pixels in e.g. entity
movement code.)
* Try rewriting `db 0` or `NOP` padding instructions in ASM land into `even`
or `align 2` directives. This makes mzdiffs a bit shorter in common cases
where a single byte was erroneously added somewhere, by providing a chance
for the code to catch up to its original byte positions.
* Documenting function comments exclusively go into C/C++ header files, right
above the corresponding function prototype, *not* into ASM slices.