You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: code-conventions.md
+11Lines changed: 11 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -314,3 +314,14 @@ The exceptions are `Material.AIR`, which is a good way to represent "nothing"
314
314
and `Material.STONE` which can be used to get a dummy `ItemMeta`.
315
315
316
316
Prefer to avoid referencing the Biome enum directly, since it has changed between versons in the past.
317
+
318
+
### Deprecating
319
+
320
+
When deprecating a Java element (such as a class, method, or constructor):
321
+
322
+
1. Replace all internal usages of the deprecated element within the Skript codebase.
323
+
2. Add a Javadoc `@deprecated` tag that states the recommended alternative.
324
+
3. Annotate the element with `@Deprecated(since = "INSERT VERSION", forRemoval = true)` to indicate it is scheduled for removal and what feature version it was deprecated.
325
+
326
+
Deprecation PRs are typically merged for a feature release, so the PR should target `dev/feature` branch.
327
+
Deprecated elements may be removed three feature releases after the version they were deprecated in.
0 commit comments