Skip to content

Commit d4e2fc1

Browse files
authored
Revamp feature request template for clarity and focus (#148)
1 parent 2dc0d4e commit d4e2fc1

File tree

1 file changed

+21
-21
lines changed

1 file changed

+21
-21
lines changed
Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,33 @@
11
---
22
name: Feature request
3-
about: Suggest an idea for Fast-LLM
4-
title: "[feat] Brief description of the feature"
3+
about: Propose a **practical, high-impact** improvement to Fast-LLM
4+
title: "Brief description of the feature"
55
labels: enhancement
66
assignees: ''
77

88
---
99

10-
# 🧐 Problem Description
10+
# 🎯 **Goal (What & Why)**
11+
> **Clearly state the purpose of this feature.**
12+
> _(Example: Add FP8 support using torchao to improve training throughput by 1.5x.)_
1113
12-
Is your feature request related to a specific problem? Please describe it clearly.
13-
For example: "I'm always frustrated when [...]"
14+
# 🚀 **Execution Plan**
15+
> _(This section may start as an incomplete draft but must be defined before implementation begins.)_
1416
15-
# 💡 Proposed Solution
17+
### **Step 1: What is the smallest working version?**
18+
> _(Describe the simplest way to implement this feature with minimal effort.)_
1619
17-
Describe the solution you would like to see.
18-
Be as specific as possible about how it would work or be implemented.
20+
### **Step 2: What additional optimizations are possible (but optional)?**
21+
> _(List potential refinements that can be added in later PRs if needed.)_
1922
20-
# 🔄 Alternatives Considered
23+
# 📌 **Acceptance Criteria** (Must-Haves for Completion)
24+
* The feature must be **functional and tested**.
25+
* The implementation must be **documented in practical terms**.
26+
* The PR must include a **performance/impact summary**.
27+
* **No refactors unless directly necessary** for feature completion.
2128

22-
Have you considered any alternative solutions or approaches?
23-
If so, please describe them and explain why they might not be ideal.
24-
25-
# 📈 Potential Benefits
26-
27-
Explain how this feature could benefit Fast-LLM users.
28-
Consider how it might improve performance, usability, scalability, etc.
29-
30-
# 📝 Additional Context
31-
32-
Add any other context or information that could help us understand the feature request better.
33-
If applicable, provide links to relevant references or examples.
29+
# 🛠️ **Project Management**
30+
- [ ] **Assign the project to the Fast-LLM project.**
31+
- [ ] **Set the `Estimate` field (in days) in the GitHub project.**
32+
- [ ] **Use the `Size` field to categorize the PR size (Small/Medium/Large).**
33+
- [ ] **Assign an owner when opening the issue.**

0 commit comments

Comments
 (0)