Skip to content
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.

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

Improve Contribution.md #36

Open
OneLiteFeather opened this issue May 26, 2024 · 0 comments
Open

Improve Contribution.md #36

OneLiteFeather opened this issue May 26, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@OneLiteFeather
Copy link

OneLiteFeather commented May 26, 2024

To get more consistency in our code, we decided to use this template for deprecations which is applied to all contributions. In order to do so, you have to add this into our CONTRIBUTING.md

/**
 * This method does ...
 * @deprecated As of <product> <version>, because ... use
 *             {@link #replacementMethod()} instead.
 */
@Deprecated
public void deprecatedMethod() {
    // ...
}
@OneLiteFeather OneLiteFeather converted this from a draft issue May 26, 2024
@OneLiteFeather OneLiteFeather added documentation Improvements or additions to documentation good first issue Good for newcomers labels May 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
Status: New
Development

No branches or pull requests

1 participant