backups/4jcraft
1
0
Fork 0
mirror of https://github.com/4jcraft/4jcraft.git synced 2026-04-29 18:23:36 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

docs: clarify comment policy

Browse source
This commit is contained in:
Tropical 2026-03-09 20:35:02 -05:00
parent d6b8d665df
commit 10009abcc5
1 changed files with 3 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
CONTRIBUTING.md
View file

@ -42,7 +42,7 @@ At this time, we are trying to stay as close to the vanilla game as close as pos
### Bugfixes should be clearly commented.
If you are submitting a bugfix or a minor addition to *game-relevant code*, clearly comment the purpose of this fix in a comment starting with `// 4jcraft:`. This indicates a patch over the original game code and lets us keep track of what has been modified in case it needs to be reverted later.
If you are submitting a minor addition to *game-relevant code*, clearly comment the purpose of this in a comment starting with `// 4jcraft:`. This indicates a patch over the original game code and lets us keep track of what has been modified in case it needs to be reverted later.
> **Example:**
>
@ -54,6 +54,8 @@ If you are submitting a bugfix or a minor addition to *game-relevant code*, clea
> dos->writeShort((id & 0x07FF) | 0x800);
> ```
This rule may not apply to contributions fixing *trivially incorrect* 4J code that affects all platforms, such as instances of undefined behavior.
### Try to fix the cause, not the effect.
If you are fixing a bug, avoid submitting "hacks" that attempt to patch the effects of the bug rather than the root cause.