aboutsummaryrefslogtreecommitdiffhomepage
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorNassim Jahnke <[email protected]>2024-01-18 15:56:25 +0100
committerNassim Jahnke <[email protected]>2024-01-18 15:56:25 +0100
commit5e73c555bc9d0d6debc14c947efcd33c80ade2af (patch)
treea3397471cb426e2df752c5dd38a4131610679ec2 /CONTRIBUTING.md
parent94807a1d2e74b26b1a3154974d4024daa4c95f51 (diff)
downloadPaper-5e73c555bc9d0d6debc14c947efcd33c80ade2af.tar.gz
Paper-5e73c555bc9d0d6debc14c947efcd33c80ade2af.zip
[ci skip] Add more identifying patch comments
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md3
1 files changed, 2 insertions, 1 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index b845f7dd0d..a2fa410d3c 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -204,7 +204,8 @@ when making and submitting changes.
## Formatting
-All modifications to non-Paper files should be marked.
+All modifications to non-Paper files should be marked. The one exception to this is
+when modifying javadoc comments, which should not have these markers.
- You need to add a comment with a short and identifiable description of the patch:
`// Paper start - <COMMIT DESCRIPTION>`