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

Do we want a QC check to ensure that all deprecated classes have an obsoletion reason? #6968

Open
matentzn opened this issue Dec 7, 2023 · 9 comments · May be fixed by #6969
Open

Do we want a QC check to ensure that all deprecated classes have an obsoletion reason? #6968

matentzn opened this issue Dec 7, 2023 · 9 comments · May be fixed by #6969
Assignees

Comments

@matentzn
Copy link
Member

matentzn commented Dec 7, 2023

If we decide against it, just close this issue here.

@nicolevasilevsky
Copy link
Member

it would be nice to have this but probably more effort than it is worth to go back and add obs reasons to all of the terms that do not already have one

@matentzn
Copy link
Member Author

matentzn commented Dec 7, 2023

One option is to give all the ones that are currently missing an obsolescence reason a blanket reason (say, "out of scope") or similar, so that we can activate the QC check for the future. We could also create a (closed) issue explaining the obsoletion "Deprecated classes without an obsoletion reason" and link all classes to this ticket; this ticket could then have an explanation that we did not track obsoletion reasons when this class was obsoleted, but if you want to know why it was obsoleted, you can open a new ticket?

@nicolevasilevsky
Copy link
Member

I like both of these ideas @matentzn. I'm in favor of doing this.

@twhetzel
Copy link
Collaborator

twhetzel commented Dec 8, 2023

I am in favor of adding the qc check and also adding the blanket reason with a ticket reference for any class that does not already have an obsoletion reason.

@matentzn
Copy link
Member Author

matentzn commented Dec 8, 2023

Yes, I didnt think to also say this clearly: Do we think that all obsoleted classes should be linked to a GitHub issue? I think this would be a pretty awesome show of transparency as well.

@sabrinatoro
Copy link
Collaborator

Yes to everything BUT I think there are a lot of "old" obsoleted classes for which there might not be a GH issue. So we need to have a plan for these.

@matentzn
Copy link
Member Author

matentzn commented Dec 8, 2023

The same idea as above: a blanket issue explaining that this term was obsoleted before there was a system, and there is therefore no issue tracker connected.

@nicolevasilevsky
Copy link
Member

I am in favor of all of this

@matentzn
Copy link
Member Author

matentzn commented Dec 12, 2023

  • @nicolevasilevsky can you create a beautifully formatted issue then, that explains this situation, and close it, and link it here? I will work on the rest.

  • Also, I need to know which "deprecation reason" to use for these cases. Do you want to coin a new one? "MONDO:UnspecifiedObsoletionReason"? Or re-use one of the existing ones?

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 a pull request may close this issue.

4 participants