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.

Sign up for GitHub

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

Merged
merged 3 commits into from
Feb 8, 2022
Merged

Add GitHub issue template for deprecated APIs #9006

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ca28f5f
add api deprecation issue template
scottn12 Feb 3, 2022
00498b0
add a line to describe the API
scottn12 Feb 4, 2022
ceb552b
add compat section and reminder to assign the issue
scottn12 Feb 7, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 34 additions & 0 deletions .github/ISSUE_TEMPLATE/api_deprecation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
---
name: Deprecated API
about: Track the cleanup of a deprecated API
title: ''
labels: 'api deprecation'
assignees: ''
Copy link
Contributor Author

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

Copy link
Contributor

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

Copy link
Contributor Author

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.

Copy link
Member

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.

Copy link
Contributor Author

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?


---

## Deprecated API
<!-- Describe the API along with its associated classes, interfaces, packages, etc. -->

**Context**
<!-- An explanation of why this API should be deprecated and ultimately removed -->

**Approach**
<!-- An explanation of the intended replacement/solution -->

**Dependencies**
scottn12 marked this conversation as resolved.
Show resolved Hide resolved
<!-- Indicate if there are any dependencies that must be handled first -->

**Phases**
<!-- Layout a clear plan listing each step necessary to complete the cleanup -->

**Expected Timeline**
<!-- When you expect this API will be fully removed. If possible give a release version -->

**Open Questions**
<!-- List any unknowns that need to be addressed before removing the API -->


<!-- By filing an Issue, you are expected to comply with the Code of Conduct: https://github.com/microsoft/FluidFramework/blob/main/CODE_OF_CONDUCT.md -->

<!-- Lastly, be sure to preview your issue before saving. Thanks! -->