|
5 | 5 |
|
6 | 6 | Description of the proposed feature or proposed changes. |
7 | 7 |
|
8 | | -# Example |
9 | | - |
10 | | -If the proposal requires changes to the current API or the creation of new ones, add a basic code example. |
11 | | - |
12 | 8 | # Motivation |
13 | 9 |
|
14 | 10 | Please make sure to explain the motivation for this proposal. |
15 | | -It means explaining the use case(s) and the fonctional feature(s) this proposal is trying to solve. |
| 11 | +It means explaining the use case(s) and the functional feature(s) this proposal is trying to solve. |
16 | 12 |
|
17 | | -Try to only talk about the intent not the proposed solution here. |
| 13 | +Try to only talk about the intent, not the proposed solution here. |
18 | 14 |
|
19 | 15 | # Detailed design |
20 | 16 |
|
21 | | -Describe the proposal in details: |
| 17 | +Describe the proposal in detail: |
22 | 18 |
|
23 | 19 | - Explaining the design so that someone who knows Strapi can understand and someone who works on it can implement the proposal. |
24 | | -- Think about edge-cases and include examples. |
| 20 | +- Think about edge cases and include examples. |
| 21 | + |
| 22 | +# Example |
| 23 | + |
| 24 | +If the proposal requires changes to the current API or the creation of new ones, add a basic code example. |
25 | 25 |
|
26 | 26 | # Tradeoffs |
27 | 27 |
|
28 | 28 | What potential tradeoffs are involved with this proposal. |
29 | 29 |
|
30 | 30 | - Complexity |
31 | | -- Work load of implementation |
| 31 | +- Workload of implementation |
32 | 32 | - Can this be implemented outside of Strapi's core packages |
33 | 33 | - How does this proposal integrate with the current features being implemented |
34 | 34 | - Cost of migrating existing Strapi applications (is it a breaking change?) |
35 | | -- Does implementing this proposal mean reworking teaching resources (videos, tutorials, documentations)? |
| 35 | +- Does implementing this proposal mean reworking teaching resources (videos, tutorials, documentation)? |
36 | 36 |
|
37 | 37 | # Alternatives |
38 | 38 |
|
|
0 commit comments