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

Introduce tech preview/experimental features #506

Open
mnovak opened this issue Aug 29, 2022 · 2 comments
Open

Introduce tech preview/experimental features #506

mnovak opened this issue Aug 29, 2022 · 2 comments
Labels
Milestone

Comments

@mnovak
Copy link
Contributor

mnovak commented Aug 29, 2022

Until now new features and API added into XTF framework had to be as stable as possible not to break backward compatibility in the future. However it's not always possible to introduce mature API. Idea is to mark such features/APIs so the consumer that it might change or be removed in the future.

One of the options might be to introduce @Experimental annotation to mark such an API.

@mnovak mnovak added the major label Aug 29, 2022
@mchoma
Copy link
Contributor

mchoma commented Aug 29, 2022

Here is interesting article regarding this topic https://dzone.com/articles/forward-looking-with-javas-deprecated. Noteworthy alternatives to introduce own annotation are are:

  • Use guava's @beta annotation
  • reuse javas @deprecated, e.g. @deprecated(forRemoval = false, since = 0.27)
  • Handle just with comments / release notes

@simkam
Copy link
Contributor

simkam commented Aug 29, 2022

I would prefer

reuse javas @deprecated, e.g. @deprecated(forRemoval = false, since 0.27)

@tommaso-borgato tommaso-borgato added this to the BACKLOG milestone Jun 22, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

4 participants