-
Notifications
You must be signed in to change notification settings - Fork 535
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 GitHub issue template for deprecated APIs #9006
Conversation
about: Track the cleanup of a deprecated API | ||
title: '' | ||
labels: 'api deprecation' | ||
assignees: '' |
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.
Is it possible to have it automatically assign the issue to the author? If so, we may want to consider that
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.
Probably, right? If you're trying to encourage accountability of cleaning up deprecations. Otherwise in this sort of case it's kind of like throwing it into the void
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.
Yeah, I think that would be ideal, however I haven't been able to find anything documented on how to do that with templates. If it's not possible, I can just add a line to the template mentioning that it should be assigned to someone, and if you don't know who then assign yourself.
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.
Over the weekend I learned about a beta GitHub feature that might be a good fit here: https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository#creating-issue-forms.
I don't know if you can self-assign, though.
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 tested it out a little bit and it looks like you can't auto assign via issue templates and most likely not with issue forms either. However, I did find this GitHub Action that could work here. @tylerbutler what do you think?
This PR adds a GitHub issue template for deprecated APIs. The issue will automatically have the "api deprecation" label applied, and have sections generated for the recommended information to include.
If this is merged, the API deprecation wiki doc should be updated to include use of this template.