Skip to content

Add deprecation guidelines to CONTRIBUTING.md #109

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add deprecation guidelines to CONTRIBUTING.md #109

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 16 additions & 1 deletion .github/CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
- [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 <product> <version>, because ... use
* {@link #replacementMethod()} instead.
*/
@Deprecated
public void deprecatedMethod() {
// ...
}
Loading