-
Notifications
You must be signed in to change notification settings - Fork 55
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 deprecation notice #71
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think this needs a bit more info on why the repository will be deprecated, i.e., because the core repository will contain practical use cases in the examples/
folder which replace this repository
Co-authored-by: Felix Altenberger <[email protected]>
Co-authored-by: Felix Altenberger <[email protected]>
README.md
Outdated
@@ -1,3 +1,10 @@ | |||
# IMPORTANT NOTE: THIS REPOSITORY IS GOING TO BE DEPRECATED AFTER 01/08/2023. | |||
***Please consider the impact it might have on your ongoing work and plan accordingly.*** |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actually what's the purpose of this sentence? I guess users are not installing / building upon those repositories anyways so the deprecation shouldn't break anything, it only means that the examples are outdated / no longer maintaned.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, it means that no maintenance and potentially not working code is here. Plus we will archive those, so they will get into a read-only state.
This sentence is more of a politeness - doesn't have to be a showstopper for any production work, but might get some tiny side-effects for Dev or Research.
Added:
README.md