Skip to content

Commit 8801c6b

Browse files
authored
Merge pull request #45 from WalkingPizza/fix/template
Fix some typos in the template and move the `Example` section
2 parents 812d1c5 + 55cd64e commit 8801c6b

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

xxxx-template.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -5,34 +5,34 @@
55

66
Description of the proposed feature or proposed changes.
77

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-
128
# Motivation
139

1410
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.
1612

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.
1814

1915
# Detailed design
2016

21-
Describe the proposal in details:
17+
Describe the proposal in detail:
2218

2319
- 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.
2525

2626
# Tradeoffs
2727

2828
What potential tradeoffs are involved with this proposal.
2929

3030
- Complexity
31-
- Work load of implementation
31+
- Workload of implementation
3232
- Can this be implemented outside of Strapi's core packages
3333
- How does this proposal integrate with the current features being implemented
3434
- 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)?
3636

3737
# Alternatives
3838

0 commit comments

Comments
 (0)