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

add @Incubating annotation #3647

Closed
OlegDokuka opened this issue Nov 22, 2023 · 4 comments · Fixed by #3790
Closed

add @Incubating annotation #3647

OlegDokuka opened this issue Nov 22, 2023 · 4 comments · Fixed by #3790
Assignees
Labels
type/chores A task not related to code (build, formatting, process, ...)
Milestone

Comments

@OlegDokuka
Copy link
Contributor

Rationale

Reactor is exploring new horizons so we need to have safe harbour for some of the enhancements we add. Functionality marked with @Incubating annotation would let us make breaking changes in functionality between minor incrmenets

@OlegDokuka OlegDokuka added the type/chores A task not related to code (build, formatting, process, ...) label Nov 22, 2023
@OlegDokuka OlegDokuka added this to the 3.7.0-M1 milestone Nov 22, 2023
@He-Pin
Copy link
Contributor

He-Pin commented Jan 7, 2024

FYI, Akka/Pekko is using @ApiMayChange

@chemicL chemicL modified the milestones: 3.7.0-M1, 3.7 Planning Mar 15, 2024
@violetagg
Copy link
Member

violetagg commented Apr 19, 2024

@chemicL I think it's time to introduce this annotation. We have several options. Wdyt?

  • @Incubating
  • @ApiMayChange
  • @Experimental
  • @UnstableApi

@chemicL
Copy link
Member

chemicL commented Apr 19, 2024

I personally prefer @Incubating. It's also used by Micrometer, Hibernate, Gradle.

@UnstableApi is also tempting as it's used by Android.

@ApiMayChange from Akka was introduced alongside with other annotations, feels like it's not as self explanatory as the above.

For @Experimental, I'd prefer not to convey such a strongly discouraging semantic that this word brings. To me, incubating is something most appropriate as long as our intention is to evolve the API but we're working on it because we believe something will make it into the API, while we are not sure yet how it will exactly be shaped. Experimental conveys the message that we might not be serious about a feature so collecting feedback might be more difficult.

WDYT @violetagg ?

@violetagg
Copy link
Member

ok with @Incubating

@violetagg violetagg modified the milestones: 3.7 Planning, 3.7.0-M2 Apr 19, 2024
violetagg added a commit that referenced this issue Apr 19, 2024
violetagg added a commit that referenced this issue Apr 19, 2024
Fixes #3647

Co-authored-by: Dariusz Jędrzejczyk <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type/chores A task not related to code (build, formatting, process, ...)
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants