Skip to content

Commit 94a4134

Browse files
Merge pull request #54 from the-collab-lab/53-introduce-a-template-to-be-used-when-creating-a-new-issue
Add structured issue template for GitHub
2 parents aaee8ec + 112026c commit 94a4134

File tree

1 file changed

+38
-0
lines changed

1 file changed

+38
-0
lines changed

.github/issue_template.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# Issue Template
2+
3+
## 🧗🏽 Challenge
4+
5+
- _Describe the use case – Who is the audience for this change (users, developers, etc.)?_
6+
- _What does the user want to accomplish?_
7+
- _Why does this matter?_
8+
- _How does this relate to our broader product/engineering objective?_
9+
- _How will we accomplish this?_
10+
11+
## ⚡️ Solution
12+
13+
- _Describe the solution, fix, or updates required._
14+
- _Provide links to supporting documentation, project briefs, or related work._
15+
- _Include any dependencies on other teams, code, or work (e.g., link to JIRAs or related GitHub issues)._
16+
17+
## 🎨 Designs
18+
19+
- _Include links to Figma files, screenshots, or designs that clearly show relevant updates for this issue. - Highlight specific changes from the current design, if applicable._
20+
21+
## ✅ Acceptance Criteria
22+
23+
_Should describe the definition of done, not the technical how-to (technical details go in the Solution section)._
24+
25+
- [ ] Clear end-state description (e.g., functionality working, UI rendering as expected, documentation created)
26+
- [ ] Tests, Documentation, and ChangeLogs are updated
27+
- [ ] Eventing: Ensure any updated/added events are captured if applicable
28+
- [ ] Reviews: Peer reviews or other team approvals
29+
- [ ] PM/Designer approval (if the solution diverges from the original plan)
30+
31+
## 🚫 Out of Scope
32+
33+
- _List any areas that are not part of the work for this issue._
34+
- _For follow-on work, link related GitHub issues._
35+
36+
## 📝 Notes
37+
38+
- _Additional context or information relevant to the issue (e.g., technical constraints, tips for implementation, or external links)._

0 commit comments

Comments
 (0)