From 05322871d62225911538aed2fb33e49f69ce3cb1 Mon Sep 17 00:00:00 2001 From: Isuru Nishadha Date: Sun, 26 Jan 2025 18:21:34 +0530 Subject: [PATCH] Add deprecation guidelines to CONTRIBUTING.md --- .github/CONTRIBUTING.md | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index d58243a1ad4..3bfbd3ae10a 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -24,4 +24,19 @@ Most of them can be obtained in (most) package managers on different platforms. - `git` - Version control system - A Java 21 or later JDK: - - [Adoptium](https://adoptium.net/) has builds for most operating systems \ No newline at end of file + - [Adoptium](https://adoptium.net/) has builds for most operating systems + +## Deprecation Guidelines + +To ensure consistency across the codebase, please use the following template when marking a method, class or functionality as deprecated + +```java +/** + * This method does ... + * @deprecated As of , because ... use + * {@link #replacementMethod()} instead. + */ +@Deprecated +public void deprecatedMethod() { + // ... +} \ No newline at end of file