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

Streamline sharing of deprecation rules between users #13

Open
dkhalanskyjb opened this issue Sep 25, 2024 · 0 comments
Open

Streamline sharing of deprecation rules between users #13

dkhalanskyjb opened this issue Sep 25, 2024 · 0 comments

Comments

@dkhalanskyjb
Copy link

Imagine I'm an expert in how to use a library. I know that some function is error-prone, and I have some audience that I want not to get hurt by that function, an audience wider than just the project I'm working on. What are my options?

  • Write a blog post, explaining the perils of using various functions. With this approach, my readers have to actively learn about functions they don't want to use and always keep them in mind.
  • Publish a set of kapifence rules. That's already much better, but still not perfect: I have no way to let my audience know that I have news of some other API entries they should avoid. My readers have to explicitly keep reading my updates to get the newest list.
  • Publish a Gradle plugin utilizing kapifence. Now, my readers can just apply my plugin, and a Dependabot or something like that will notify them about new versions. However, this requires that I understand how Gradle works and how to write a Gradle plugin, which is a demanding task, so I'm probably just not going to do that. Also, my readers may be wary of applying some obscure plugin to their build scripts.

It would be nice to have a streamlined process (an instruction, a template project, or something like that) that would allow experts to easily share their knowledge of deprecated APIs for other projects to use.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant