Skip to content

Commit 14e3c99

Browse files
committed
docs: git: feature design: reword
1 parent 35d4848 commit 14e3c99

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

.github/ISSUE_TEMPLATE/feature_design.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,5 +5,7 @@ title: "[Feature Design] Your Title Goes There"
55
---
66

77
This text is a guideline. You can remove it before posting the issue.
8-
- A Feature Design is a proposal that describes the problem and provides one or more solutions to it. Use it if you are a developer and you want to add a feature to Yafc.
9-
- The purpose of the Feature Design is to showcase how important solving the problem is to the playerbase, and describe the possible solutions to estimate how much complexity the feature would bring. Yafc aims to reduce the complexity of its codebase, so the less complexity the solution adds, the better.
8+
A Feature Design is a proposal that describes the problem and provides one or more solutions to it. Use it if you are a developer and you want to add a feature to Yafc.
9+
The Feature Design has two main goals:
10+
1. Show the importance of solving the problem. Show the state before and after the problem is resolved, in order to make the improvement obvious.
11+
2. Describe possible solutions to estimate how much complexity the feature would add. Yafc aims to reduce the complexity of its codebase, so the less complexity the solution adds, the better.

0 commit comments

Comments
 (0)