From 10009abcc5a51ca34dd41650b2d0ccd96070596e Mon Sep 17 00:00:00 2001 From: Tropical <42101043+tropicaaal@users.noreply.github.com> Date: Mon, 9 Mar 2026 20:35:02 -0500 Subject: [PATCH] docs: clarify comment policy --- CONTRIBUTING.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c2ea1d362..8f6de058d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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.