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

doc: Add RELEASE_PLANS.md #2534

Closed

Conversation

ahuber21
Copy link
Contributor

I propose to add a new file: RELEASE_PLANS.md in which we collect actionable items and other TODOs for upcoming releases. My other PR #2460 deprecates some model builder functions in favor of new versions with more parameters. This file will help us to keep track of such changes.

@KulikovNikita
Copy link
Contributor

Looks interesting to me

Copy link
Contributor

@aepanchi aepanchi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

small suggestion, the rest looks good

@@ -0,0 +1,6 @@
# Upcoming releases: Plans and required actions
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
# Upcoming releases: Plans and required actions
# Upcoming Releases: Plans and Required Actions

@napetrov
Copy link
Contributor

napetrov commented Oct 5, 2023

Talked offline but also would put this here.
The intent of this change is to have forcing function for cleaning up deprecated functionality - but i don't see how this implementation would help, other than adding another place with deprecation mention.

Also from terminology perspective
deprecation - is fact of declaring deprecation that something will be removed
removal - is actually fact of removing functionality/api

So we have to declare deprecation in:

  1. release notes
  2. deprecated functionality section in documentation
  3. potentially add deprecated mechanics in code

From removal perspective this have to be an activity planned for next major release to complete cleanup.

Also important considerations - deprecating functionality in code and comments should be done without implying versions. i.e. deprecated functionality is not enforcing timelines or targets.

@ahuber21
Copy link
Contributor Author

ahuber21 commented Oct 5, 2023

Thank you Nikolay, these points make sense to me. Closing this PR as we'll be taking a different route.

@ahuber21 ahuber21 closed this Oct 5, 2023
@ahuber21 ahuber21 deleted the dev/ahuber/add-release-plans branch October 5, 2023 11:18
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

Successfully merging this pull request may close these issues.

4 participants