Skip to content

Commit 301016a

Browse files
authored
chore: update issue template for feature proposal
1 parent 117405b commit 301016a

File tree

1 file changed

+85
-13
lines changed

1 file changed

+85
-13
lines changed
Lines changed: 85 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,97 @@
1-
---
2-
name: Feature request
3-
about: Suggest an idea for this project
1+
<!-- This is taken from https://github.com/eslint/rfcs -->
42

5-
---
6-
<!-- Please don't delete this template or we'll close your issue -->
7-
<!-- Please use English language -->
8-
<!-- Before creating an issue please make sure you are using the latest version of Docsify. -->
9-
<!-- Please ask questions on StackOverflow 👉 https://stackoverflow.com/questions/ask?tags=docsify -->
3+
# (title goes here)
104

11-
## Feature request
5+
## Summary
126

13-
#### What problem does this feature solve?
7+
<!-- One-paragraph explanation of the feature. -->
148

9+
## Motivation
1510

11+
<!-- Why are we doing this? What use cases does it support? What is the expected
12+
outcome? -->
1613

17-
#### What does the proposed API look like?
14+
## Detailed Design
1815

16+
<!--
17+
This is the bulk of the RFC.
18+
Explain the design with enough detail that someone familiar with docsify
19+
can implement it by reading this document. Please get into specifics
20+
of your approach, corner cases, and examples of how the change will be
21+
used. Be sure to define any new terms in this section.
22+
-->
1923

24+
## Documentation
2025

21-
#### How should this be implemented in your opinion?
26+
<!--
27+
How will this RFC be documented?
28+
-->
2229

30+
## Drawbacks
2331

32+
<!--
33+
Why should we *not* do this? Consider why adding this into Docsify
34+
might not benefit the project or the community. Attempt to think
35+
about any opposing viewpoints that reviewers might bring up.
2436
25-
#### Are you willing to work on this yourself?
37+
Any change has potential downsides, including increased maintenance
38+
burden, incompatibility with other tools, breaking existing user
39+
experience, etc. Try to identify as many potential problems with
40+
implementing this proposal as possible.
41+
-->
42+
43+
## Backwards Compatibility Analysis
44+
45+
<!--
46+
How does this change affect existing Docsify users? Will any behavior
47+
change for them? If so, how are you going to minimize the disruption
48+
to existing users?
49+
-->
50+
51+
## Alternatives
52+
53+
<!--
54+
What other designs did you consider? Why did you decide against those?
55+
This section should also include prior art, such as whether similar
56+
projects have already implemented a similar feature.
57+
-->
58+
59+
## Open Questions
60+
61+
<!--
62+
This section is optional, but is suggested for a first draft.
63+
What parts of this proposal are you unclear about? What do you
64+
need to know before you can finalize this Proposal?
65+
66+
List the questions that you'd like reviewers to focus on. When
67+
you've received the answers and updated the design to reflect them,
68+
you can remove this section.
69+
-->
70+
71+
## Help Needed
72+
73+
<!--
74+
This section is optional.
75+
76+
Are you able to implement this Proposal on your own? If not, what kind
77+
of help would you need from the team?
78+
-->
79+
80+
## Frequently Asked Questions
81+
82+
<!--
83+
This section is optional but suggested.
84+
85+
Try to anticipate points of clarification that might be needed by
86+
the people reviewing this Proposal. Include those questions and answers
87+
in this section.
88+
-->
89+
90+
## Related Discussions
91+
92+
<!--
93+
This section is optional but suggested.
94+
95+
If there is an issue, pull request, or other URL that provides useful
96+
context for this proposal, please include those links here.
97+
-->

0 commit comments

Comments
 (0)