diff --git a/.github/ISSUE_TEMPLATE/BUG-REPORT.md b/.github/ISSUE_TEMPLATE/BUG-REPORT.md new file mode 100644 index 00000000..2da1ea2f --- /dev/null +++ b/.github/ISSUE_TEMPLATE/BUG-REPORT.md @@ -0,0 +1,58 @@ +## ๐Ÿงพ Preliminary Checks + +- [ ] I have searched [existing issues](https://github.com/credebl/credo-controller/issues) and [pull requests](https://github.com/credebl/credo-controller/pulls) for duplicates. +- [ ] I'm willing to create a PR fixing this issue. (if applicable). + +--- + +## ๐Ÿž Bug Description + +_A clear and concise description of what the bug is._ + +When I try to [...], I get this unexpected behavior [...] + +--- + +## ๐Ÿงช Steps to Reproduce + +_Provide clear steps to reproduce the bug._ + +1. Go to '...' +2. Click on '...' +3. Scroll down to '...' +4. See error + +--- + +## โœ… Expected Behavior + +_What did you expect to happen?_ + +--- + +## โŒ Actual Behavior + +_What actually happened instead?_ + +--- + +## ๐Ÿ“Œ Affected Version/Commit + +_Version number, branch name, or commit hash where the bug occurs._ + +--- + +## ๐Ÿ’ป Environment + +_Where did the issue occur?_ + +- [ ] Local development +- [ ] Production +- [ ] CI/CD +- [ ] Other + +--- + +## ๐Ÿงพ Relevant Logs, Screenshots, or Stack Traces + +_Paste any error messages or screenshots that can help diagnose the issue._ diff --git a/.github/ISSUE_TEMPLATE/FEATURE-REQUEST.md b/.github/ISSUE_TEMPLATE/FEATURE-REQUEST.md new file mode 100644 index 00000000..bd52e3ed --- /dev/null +++ b/.github/ISSUE_TEMPLATE/FEATURE-REQUEST.md @@ -0,0 +1,44 @@ +## โœ… Preliminary Checks + +- [ ] I have searched [existing issues](https://github.com/credebl/credo-controller/issues) and [pull requests](https://github.com/credebl/credo-controller/pulls) to avoid duplicates. +- [ ] I'm willing to create a PR for this feature. (if applicable). + +--- + +## ๐Ÿงฉ Problem Statement + +_Is your feature request related to a problem? Please describe it clearly._ + +> Ex: I'm always frustrated when [...] + +--- + +## ๐Ÿ’ก Proposed Solution + +_A clear and concise description of what you want to happen._ + +> Ex: It would be great if [...] + +--- + +## ๐Ÿ”„ Alternatives Considered + +_Have you considered any alternative solutions or features?_ + +> Ex: I also thought about [...], but [...] + +--- + +## ๐Ÿ“Ž Additional Context + +_Add any other context, references, mockups, or screenshots here._ + +--- + +## โœ… Acceptance Criteria + +_List specific tasks or outcomes that define when this request is complete._ + +- A new endpoint `/v1/...` is added +- Docs updated +- Tests written and passing