Skip to content

Commit

Permalink
Update deprecation-template.md (#419)
Browse files Browse the repository at this point in the history
* Update deprecation-template.md

* Update deprecation-template.md
  • Loading branch information
locks authored Dec 19, 2018
1 parent cf940bb commit 8bfc473
Showing 1 changed file with 20 additions and 22 deletions.
42 changes: 20 additions & 22 deletions deprecation-template.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,50 +2,48 @@
- RFC PR: (leave this empty)
- Ember Issue: (leave this empty)

# Summary
# <RFC title>

## Summary

One paragraph explanation of the deprecation.
> One paragraph explanation of the deprecation.
# Motivation
## Motivation

Why are we doing this? What are the problems with the deprecated feature?
> Why are we doing this? What are the problems with the deprecated feature?
What is the replacement functionality?

# Transition Path

This is the bulk of the RFC. Explain the use-cases that deprecated functionality
covers, and for each use-case, describe the transition path.
## Transition Path

> This is the bulk of the RFC. Explain the use-cases that deprecated functionality
covers, and for each use-case, describe the transition path.
Describe it in enough detail for someone who uses the deprecated functionality
to understand, for someone to write the deprecation guide, and for someone
familiar with the implementation to implement.

# How We Teach This
## How We Teach This

Would the acceptance of this proposal mean the Ember guides must be
> Would the acceptance of this proposal mean the Ember guides must be
re-organized or altered? Does it change how Ember is taught to new users
at any level?

at any level?
Does it mean we need to put effort into highlighting the replacement
functionality more? What should we do about documentation, in the guides
related to this feature?

related to this feature?
How should this deprecation be introduced and explained to existing Ember
users?

# Drawbacks
## Drawbacks

Why should we *not* do this? Please consider the impact on teaching Ember,
> Why should we *not* do this? Please consider the impact on teaching Ember,
on the integration of this feature with other existing and planned features,
on the impact of the API churn on existing apps, etc.

on the impact of the API churn on existing apps, etc.
There are tradeoffs to choosing any path, please attempt to identify them here.

# Alternatives
## Alternatives

What other designs have been considered? What is the impact of not doing this?
> What other designs have been considered? What is the impact of not doing this?
# Unresolved questions
## Unresolved questions

Optional, but suggested for first drafts. What parts of the design are still
> Optional, but suggested for first drafts. What parts of the design are still
TBD?

0 comments on commit 8bfc473

Please sign in to comment.