Skip to content

Commit 29ebbdc

Browse files
GHkrishnaGHkrishna
authored
update template content (#1246)
* Update FEATURE-REQUEST.yml with note Signed-off-by: Krishna Waske <[email protected]> * Update bug_report.yml Signed-off-by: Krishna Waske <[email protected]> * Update bug_report.yml Signed-off-by: Krishna Waske <[email protected]> * Update triage Signed-off-by: Krishna Waske <[email protected]> --------- Signed-off-by: Krishna Waske <[email protected]>
1 parent 57fce3b commit 29ebbdc

File tree

2 files changed

+118
-83
lines changed

2 files changed

+118
-83
lines changed

‎.github/ISSUE_TEMPLATE/FEATURE-REQUEST.yml‎

Lines changed: 55 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -1,57 +1,73 @@
1-
name: "🚀 Feature Request"
2-
description: Suggest an idea or enhancement for this project
3-
labels: [enhancement]
1+
name: "\U0001F680 Feature Request - new"
42
title: "feat: "
3+
description: Suggest an idea or enhancement for CREDEBL platform
4+
labels: [enhancement, triage]
55
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
## Reporting a feature request/enhancement to CREDEBL
10+
11+
Thank you for taking time to create a feature request for CREDEBL, your contribution will help
12+
make the product better for everyone.
13+
14+
Make sure your issue has a generous description that will help others understand and fix it at earliest.
15+
616
- type: checkboxes
7-
id: agreement
17+
id: preliminary-checks
818
attributes:
9-
label: Preliminary Checks
19+
label: "✅ Preliminary Checks"
20+
description: "Please confirm the following before submitting."
1021
options:
1122
- label: "I've read the [contibution guide](https://docs.credebl.id/docs/contribute/how-to-contribute) and agree to it"
1223
required: true
1324
- label: "I have searched [existing issues](https://github.com/credebl/platform/issues) and [pull requests](https://github.com/credebl/platform/pulls) to avoid duplicates."
1425
required: true
1526
- label: "I'm willing to create a PR for this feature. (if applicable)."
16-
- type: markdown
17-
attributes:
18-
value: |
19-
## 🧩 Problem Statement
20-
21-
_Is your feature request related to a problem? Please describe it clearly._
22-
23-
> Ex: I'm always frustrated when [...]
24-
25-
---
26-
27-
## 💡 Proposed Solution
28-
29-
_A clear and concise description of what you want to happen._
30-
31-
> Ex: It would be great if [...]
32-
33-
---
34-
35-
## 🔄 Alternatives Considered
3627

37-
_Have you considered any alternative solutions or features?_
38-
39-
> Ex: I also thought about [...], but [...]
40-
41-
---
42-
43-
## 📎 Additional Context
44-
45-
_Add any other context, references, mockups, or screenshots here._
28+
- type: textarea
29+
id: problem-statement
30+
attributes:
31+
label: "🧩 Problem Statement"
32+
description: "Is your feature request related to a problem? Please describe it clearly."
33+
placeholder: "Ex: I'm always frustrated when [...]"
34+
validations:
35+
required: true
4636

47-
---
37+
- type: textarea
38+
id: proposed-solution
39+
attributes:
40+
label: "💡 Proposed Solution"
41+
description: "A clear and concise description of what you want to happen."
42+
placeholder: "Ex: It would be great if [...]"
43+
validations:
44+
required: true
4845

49-
## ✅ Acceptance Criteria
46+
- type: textarea
47+
id: alternatives-considered
48+
attributes:
49+
label: "🔄 Alternatives Considered"
50+
description: "Have you considered any alternative solutions or features?"
51+
placeholder: "Ex: I also thought about [...], but [...]"
52+
validations:
53+
required: false
5054

51-
_List specific tasks or outcomes that define when this request is complete._
55+
- type: textarea
56+
id: additional-context
57+
attributes:
58+
label: "📎 Additional Context"
59+
description: "Add any other context, references, mockups, or screenshots here."
60+
validations:
61+
required: false
5262

53-
- A new endpoint `/v1/...` is added
54-
- Docs updated
63+
- type: textarea
64+
id: acceptance-criteria
65+
attributes:
66+
label: "✅ Acceptance Criteria"
67+
description: "List specific tasks or outcomes that define when this request is complete."
68+
placeholder: |
69+
- A new endpoint `/v1/...` is added
70+
- Docs updated
5571
- Tests written and passing
5672
validations:
5773
required: false

‎.github/ISSUE_TEMPLATE/bug_report.yml‎

Lines changed: 63 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,15 @@ description: Report a bug or unexpected behavior in the project
33
labels: [bug]
44
title: "fix: "
55
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
## Reporting a bug on CREDEBL
10+
11+
Thank you for taking time to report the bug on CREDEBL, your contribution will help
12+
make the product better for everyone.
13+
14+
Make sure your issue has a generous description that will help others understand and fix it at earliest.
615
- type: checkboxes
716
id: agreement
817
attributes:
@@ -13,59 +22,69 @@ body:
1322
- label: I have searched [existing issues](https://github.com/credebl/platform/issues) and [pull requests](https://github.com/credebl/platform/pulls) to avoid duplicates.
1423
required: true
1524
- label: "I'm willing to create a PR for this feature. (if applicable)."
16-
- type: markdown
25+
- type: textarea
26+
id: steps-to-reproduce
1727
attributes:
18-
value: |
19-
## 🐞 Bug Description
20-
21-
_A clear and concise description of what the bug is._
22-
23-
When I try to [...], I get this unexpected behavior [...]
24-
25-
---
26-
27-
## 🧪 Steps to Reproduce
28-
29-
_Provide clear steps to reproduce the bug._
30-
28+
label: "🧪 Steps to Reproduce"
29+
description: "Provide clear steps to reproduce the bug."
30+
placeholder: |
3131
1. Go to '...'
3232
2. Click on '...'
3333
3. Scroll down to '...'
3434
4. See error
35+
validations:
36+
required: true
3537

36-
---
37-
38-
## ✅ Expected Behavior
39-
40-
_What did you expect to happen?_
41-
42-
---
43-
44-
## ❌ Actual Behavior
45-
46-
_What actually happened instead?_
47-
48-
---
49-
50-
## 📌 Affected Version/Commit
51-
52-
_Version number, branch name, or commit hash where the bug occurs._
53-
54-
---
55-
56-
## 💻 Environment
57-
58-
_Where did the issue occur?_
38+
- type: textarea
39+
id: expected-behavior
40+
attributes:
41+
label: "✅ Expected Behavior"
42+
description: "What did you expect to happen?"
43+
placeholder: |
44+
Ex: After clicking 'Submit', I expected a confirmation modal to appear.
45+
validations:
46+
required: true
5947

60-
- [ ] Local development
61-
- [ ] Production
62-
- [ ] CI/CD
63-
- [ ] Other
48+
- type: textarea
49+
id: current-behavior
50+
attributes:
51+
label: "❌ Current Behavior"
52+
description: "What is currently happening instead?"
53+
placeholder: |
54+
Ex: The page crashed with a 500 error when clicking 'Submit'.
55+
validations:
56+
required: true
6457

65-
---
58+
- type: input
59+
id: affected-version
60+
attributes:
61+
label: "📌 Affected Version/Commit"
62+
description: "Version number, branch name, or commit hash where the bug occurs."
63+
placeholder: "e.g., v1.2.3, main, 4f3e2d1"
64+
validations:
65+
required: false
6666

67-
## 🧾 Relevant Logs, Screenshots, or Stack Traces
67+
- type: checkboxes
68+
id: environment
69+
attributes:
70+
label: "💻 Environment"
71+
description: "Where did the issue occur?"
72+
options:
73+
- label: "Local development"
74+
- label: "Production"
75+
- label: "CI/CD"
76+
- label: "Other"
6877

69-
_Paste any error messages or screenshots that can help diagnose the issue._
78+
- type: textarea
79+
id: logs-and-screenshots
80+
attributes:
81+
label: "🧾 Relevant Logs, Screenshots, or Stack Traces"
82+
description: "Paste any error messages or screenshots that can help diagnose the issue."
83+
placeholder: |
84+
Please include:
85+
- Error logs
86+
- Screenshots
87+
- Console output
88+
- Stack traces
7089
validations:
7190
required: false

0 commit comments

Comments
 (0)