Skip to content

Commit 8bfc473

Browse files
authored
Update deprecation-template.md (#419)
* Update deprecation-template.md * Update deprecation-template.md
1 parent cf940bb commit 8bfc473

File tree

1 file changed

+20
-22
lines changed

1 file changed

+20
-22
lines changed

deprecation-template.md

+20-22
Original file line numberDiff line numberDiff line change
@@ -2,50 +2,48 @@
22
- RFC PR: (leave this empty)
33
- Ember Issue: (leave this empty)
44

5-
# Summary
5+
# <RFC title>
6+
7+
## Summary
68

7-
One paragraph explanation of the deprecation.
9+
> One paragraph explanation of the deprecation.
810
9-
# Motivation
11+
## Motivation
1012

11-
Why are we doing this? What are the problems with the deprecated feature?
13+
> Why are we doing this? What are the problems with the deprecated feature?
1214
What is the replacement functionality?
1315

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

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

23-
# How We Teach This
24+
## How We Teach This
2425

25-
Would the acceptance of this proposal mean the Ember guides must be
26+
> Would the acceptance of this proposal mean the Ember guides must be
2627
re-organized or altered? Does it change how Ember is taught to new users
27-
at any level?
28-
28+
at any level?
2929
Does it mean we need to put effort into highlighting the replacement
3030
functionality more? What should we do about documentation, in the guides
31-
related to this feature?
32-
31+
related to this feature?
3332
How should this deprecation be introduced and explained to existing Ember
3433
users?
3534

36-
# Drawbacks
35+
## Drawbacks
3736

38-
Why should we *not* do this? Please consider the impact on teaching Ember,
37+
> Why should we *not* do this? Please consider the impact on teaching Ember,
3938
on the integration of this feature with other existing and planned features,
40-
on the impact of the API churn on existing apps, etc.
41-
39+
on the impact of the API churn on existing apps, etc.
4240
There are tradeoffs to choosing any path, please attempt to identify them here.
4341

44-
# Alternatives
42+
## Alternatives
4543

46-
What other designs have been considered? What is the impact of not doing this?
44+
> What other designs have been considered? What is the impact of not doing this?
4745
48-
# Unresolved questions
46+
## Unresolved questions
4947

50-
Optional, but suggested for first drafts. What parts of the design are still
48+
> Optional, but suggested for first drafts. What parts of the design are still
5149
TBD?

0 commit comments

Comments
 (0)