Skip to content

Commit f699e56

Browse files
authored
Create FEATURE-REQUEST.md (#1181)
* Create FEATURE-REQUEST.md Create FEATURE-REQUEST.md Signed-off-by: Krishna Waske <[email protected]> * Update bug_report.md Update bug_report.md Signed-off-by: Krishna Waske <[email protected]> * Update FEATURE-REQUEST.md change links Signed-off-by: Krishna Waske <[email protected]> * Update bug_report.md Signed-off-by: Krishna Waske <[email protected]> --------- Signed-off-by: Krishna Waske <[email protected]>
1 parent fc2f098 commit f699e56

File tree

2 files changed

+92
-21
lines changed

2 files changed

+92
-21
lines changed
Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
## ✅ Preliminary Checks
2+
3+
- [ ] I have searched [existing issues](https://github.com/credebl/platform/issues) and [pull requests](https://github.com/credebl/platform/pulls) to avoid duplicates.
4+
- [ ] I'm willing to create a PR for this feature. (if applicable).
5+
6+
---
7+
8+
## 🧩 Problem Statement
9+
10+
_Is your feature request related to a problem? Please describe it clearly._
11+
12+
> Ex: I'm always frustrated when [...]
13+
14+
---
15+
16+
## 💡 Proposed Solution
17+
18+
_A clear and concise description of what you want to happen._
19+
20+
> Ex: It would be great if [...]
21+
22+
---
23+
24+
## 🔄 Alternatives Considered
25+
26+
_Have you considered any alternative solutions or features?_
27+
28+
> Ex: I also thought about [...], but [...]
29+
30+
---
31+
32+
## 📎 Additional Context
33+
34+
_Add any other context, references, mockups, or screenshots here._
35+
36+
---
37+
38+
## ✅ Acceptance Criteria
39+
40+
_List specific tasks or outcomes that define when this request is complete._
41+
42+
- A new endpoint `/v1/...` is added
43+
- Docs updated
44+
- Tests written and passing
Lines changed: 48 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,58 @@
1+
## 🧾 Preliminary Checks
2+
3+
- [ ] I have searched [existing issues](https://github.com/credebl/platform/issues) and [pull requests](https://github.com/credebl/platform/pulls) for duplicates.
4+
- [ ] I'm willing to create a PR fixing this issue. (if applicable).
5+
6+
---
7+
8+
## 🐞 Bug Description
9+
10+
_A clear and concise description of what the bug is._
11+
12+
When I try to [...], I get this unexpected behavior [...]
13+
14+
---
15+
16+
## 🧪 Steps to Reproduce
17+
18+
_Provide clear steps to reproduce the bug._
19+
20+
1. Go to '...'
21+
2. Click on '...'
22+
3. Scroll down to '...'
23+
4. See error
24+
125
---
2-
name: Bug report
3-
about: Create a report to help us improve
4-
title: ''
5-
labels: ''
6-
assignees: ''
26+
27+
## ✅ Expected Behavior
28+
29+
_What did you expect to happen?_
730

831
---
932

10-
**Prerequisites**
33+
## ❌ Actual Behavior
1134

12-
**Steps to Reproduce**
35+
_What actually happened instead?_
1336

14-
**Current behavior**
37+
---
38+
39+
## 📌 Affected Version/Commit
1540

16-
**Expected behavior**
41+
_Version number, branch name, or commit hash where the bug occurs._
1742

18-
**Environment**
43+
---
44+
45+
## 💻 Environment
46+
47+
_Where did the issue occur?_
48+
49+
- [ ] Local development
50+
- [ ] Production
51+
- [ ] CI/CD
52+
- [ ] Other
53+
54+
---
1955

20-
**Desktop**
21-
- OS:
22-
- Browser:
23-
- Browser Version:
24-
- CREDEBL Version:
25-
26-
**Smartphone**
27-
- Device:
28-
- OS:
29-
- ADEYA version:
56+
## 🧾 Relevant Logs, Screenshots, or Stack Traces
3057

31-
**Screenshots or Screen recording**
58+
_Paste any error messages or screenshots that can help diagnose the issue._

0 commit comments

Comments
 (0)