From bf619da740f5f9210915099918a362c7d6f0c23e Mon Sep 17 00:00:00 2001 From: Krishna Waske Date: Thu, 10 Apr 2025 12:19:27 +0530 Subject: [PATCH 01/10] Create FEATURE-REQUEST.yml Create a feature request template Signed-off-by: Krishna Waske Signed-off-by: Krishna Waske --- .github/ISSUE_TEMPLATE/FEATURE-REQUEST.yml | 55 ++++++++++++++++++++++ 1 file changed, 55 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/FEATURE-REQUEST.yml diff --git a/.github/ISSUE_TEMPLATE/FEATURE-REQUEST.yml b/.github/ISSUE_TEMPLATE/FEATURE-REQUEST.yml new file mode 100644 index 00000000..738578ed --- /dev/null +++ b/.github/ISSUE_TEMPLATE/FEATURE-REQUEST.yml @@ -0,0 +1,55 @@ +name: "Feature Request" +description: Suggest a new idea or improvement for this project. +title: "[Feature] " +labels: ["enhancement"] +body: + - type: checkboxes + id: checks + attributes: + label: Preliminary Checks + description: Please ensure you've done the following before submitting a feature request. + options: + - label: I have searched [existing issues](../issues) and [pull requests](../pulls) to avoid duplicates. + required: true + - label: I have read the [contributing guidelines](../blob/main/CONTRIBUTING.md) (if applicable). + required: false + + - type: textarea + id: problem + attributes: + label: Problem Statement + description: Is your feature request related to a problem? Please describe it clearly. + placeholder: | + Ex: I'm always frustrated when [...] + + - type: textarea + id: solution + attributes: + label: Proposed Solution + description: A clear and concise description of what you want to happen. + placeholder: | + Ex: It would be great if [...] + + - type: textarea + id: alternatives + attributes: + label: Alternatives Considered + description: Have you considered any alternative solutions or features? + placeholder: | + Ex: I also thought about [...], but [...] + + - type: textarea + id: context + attributes: + label: Additional Context + description: Add any other context, references, mockups, or screenshots here. + + - type: textarea + id: acceptance + attributes: + label: Acceptance Criteria + description: List specific tasks or outcomes that define when this request is complete. + placeholder: | + - [ ] A new endpoint `/v1/...` is added + - [ ] Docs updated + - [ ] Tests written and passing From 7f6cda3f4038634d45af8cdfb52965d460041e27 Mon Sep 17 00:00:00 2001 From: Krishna Waske Date: Thu, 10 Apr 2025 12:32:15 +0530 Subject: [PATCH 02/10] Create BUG-REPORT.yml Create a bug report template Signed-off-by: Krishna Waske Signed-off-by: Krishna Waske --- .github/ISSUE_TEMPLATE/BUG-REPORT.yml | 76 +++++++++++++++++++++++++++ 1 file changed, 76 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/BUG-REPORT.yml diff --git a/.github/ISSUE_TEMPLATE/BUG-REPORT.yml b/.github/ISSUE_TEMPLATE/BUG-REPORT.yml new file mode 100644 index 00000000..e1050485 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/BUG-REPORT.yml @@ -0,0 +1,76 @@ +name: "๐Ÿ› Bug Report" +description: Report something that isn't working as expected. +title: "[Bug] " +labels: ["bug"] +body: + - type: checkboxes + id: checks + attributes: + label: Preliminary Checks + description: Please confirm the following before submitting your bug report. + options: + - label: I have searched [existing issues](../issues) and [pull requests](../pulls) for duplicates. + required: true + - label: I have read the [contributing guidelines](../blob/main/CONTRIBUTING.md) (if applicable). + required: false + + - type: textarea + id: description + attributes: + label: Bug Description + description: A clear and concise description of what the bug is. + placeholder: | + When I try to [...], I get this unexpected behavior [...] + + - type: textarea + id: steps + attributes: + label: Steps to Reproduce + description: Provide clear steps to reproduce the bug. + placeholder: | + 1. Go to '...' + 2. Click on '...' + 3. Scroll down to '...' + 4. See error + + - type: textarea + id: expected + attributes: + label: Expected Behavior + description: What did you expect to happen? + + - type: textarea + id: actual + attributes: + label: Actual Behavior + description: What actually happened instead? + + - type: input + id: version + attributes: + label: Affected Version/Commit + description: Version number, branch name, or commit hash where the bug occurs. + + - type: dropdown + id: environment + attributes: + label: Environment + description: Where did the issue occur? + options: + - Local development + - Production + - CI/CD + - Other + + - type: textarea + id: logs + attributes: + label: Relevant Logs, Screenshots, or Stack Traces + description: Paste any error messages or screenshots that can help diagnose the issue. + render: shell + + - type: textarea + id: notes + attributes: + label: Additional Notes + description: Anything else we should know? From 8d8d9fd1f0a05c49ee90eaa6535bfd9df6878347 Mon Sep 17 00:00:00 2001 From: Krishna Waske Date: Thu, 10 Apr 2025 12:52:29 +0530 Subject: [PATCH 03/10] Update and rename BUG-REPORT.yml to BUG-REPORT.md yml to md file change Signed-off-by: Krishna Waske Signed-off-by: Krishna Waske --- .github/ISSUE_TEMPLATE/BUG-REPORT.md | 60 +++++++++++++++++++++ .github/ISSUE_TEMPLATE/BUG-REPORT.yml | 76 --------------------------- 2 files changed, 60 insertions(+), 76 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/BUG-REPORT.md delete mode 100644 .github/ISSUE_TEMPLATE/BUG-REPORT.yml diff --git a/.github/ISSUE_TEMPLATE/BUG-REPORT.md b/.github/ISSUE_TEMPLATE/BUG-REPORT.md new file mode 100644 index 00000000..d9eb2c1d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/BUG-REPORT.md @@ -0,0 +1,60 @@ +## ๐Ÿงพ Preliminary Checks + +- [ ] I have searched [existing issues](../issues) and [pull requests](../pulls) for duplicates. +- [ ] I have read the [contributing guidelines](../blob/main/CONTRIBUTING.md) (if applicable). +- [ ] I'm willing to create a PR fixing this issuer. (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/BUG-REPORT.yml b/.github/ISSUE_TEMPLATE/BUG-REPORT.yml deleted file mode 100644 index e1050485..00000000 --- a/.github/ISSUE_TEMPLATE/BUG-REPORT.yml +++ /dev/null @@ -1,76 +0,0 @@ -name: "๐Ÿ› Bug Report" -description: Report something that isn't working as expected. -title: "[Bug] " -labels: ["bug"] -body: - - type: checkboxes - id: checks - attributes: - label: Preliminary Checks - description: Please confirm the following before submitting your bug report. - options: - - label: I have searched [existing issues](../issues) and [pull requests](../pulls) for duplicates. - required: true - - label: I have read the [contributing guidelines](../blob/main/CONTRIBUTING.md) (if applicable). - required: false - - - type: textarea - id: description - attributes: - label: Bug Description - description: A clear and concise description of what the bug is. - placeholder: | - When I try to [...], I get this unexpected behavior [...] - - - type: textarea - id: steps - attributes: - label: Steps to Reproduce - description: Provide clear steps to reproduce the bug. - placeholder: | - 1. Go to '...' - 2. Click on '...' - 3. Scroll down to '...' - 4. See error - - - type: textarea - id: expected - attributes: - label: Expected Behavior - description: What did you expect to happen? - - - type: textarea - id: actual - attributes: - label: Actual Behavior - description: What actually happened instead? - - - type: input - id: version - attributes: - label: Affected Version/Commit - description: Version number, branch name, or commit hash where the bug occurs. - - - type: dropdown - id: environment - attributes: - label: Environment - description: Where did the issue occur? - options: - - Local development - - Production - - CI/CD - - Other - - - type: textarea - id: logs - attributes: - label: Relevant Logs, Screenshots, or Stack Traces - description: Paste any error messages or screenshots that can help diagnose the issue. - render: shell - - - type: textarea - id: notes - attributes: - label: Additional Notes - description: Anything else we should know? From a8446d38c908aaeaaab8a8f9cff7ba4a5adad4b5 Mon Sep 17 00:00:00 2001 From: Krishna Waske Date: Thu, 10 Apr 2025 12:55:16 +0530 Subject: [PATCH 04/10] Update and rename FEATURE-REQUEST.yml to FEATURE-REQUEST.md Update and rename FEATURE-REQUEST.yml to FEATURE-REQUEST.md Signed-off-by: Krishna Waske Signed-off-by: Krishna Waske --- .github/ISSUE_TEMPLATE/FEATURE-REQUEST.md | 44 +++++++++++++++++ .github/ISSUE_TEMPLATE/FEATURE-REQUEST.yml | 55 ---------------------- 2 files changed, 44 insertions(+), 55 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/FEATURE-REQUEST.md delete mode 100644 .github/ISSUE_TEMPLATE/FEATURE-REQUEST.yml diff --git a/.github/ISSUE_TEMPLATE/FEATURE-REQUEST.md b/.github/ISSUE_TEMPLATE/FEATURE-REQUEST.md new file mode 100644 index 00000000..0e151629 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/FEATURE-REQUEST.md @@ -0,0 +1,44 @@ +## โœ… Preliminary Checks + +- [ ] I have searched [existing issues](../issues) and [pull requests](../pulls) to avoid duplicates. +- [ ] I have read the [contributing guidelines](../blob/main/CONTRIBUTING.md) (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 diff --git a/.github/ISSUE_TEMPLATE/FEATURE-REQUEST.yml b/.github/ISSUE_TEMPLATE/FEATURE-REQUEST.yml deleted file mode 100644 index 738578ed..00000000 --- a/.github/ISSUE_TEMPLATE/FEATURE-REQUEST.yml +++ /dev/null @@ -1,55 +0,0 @@ -name: "Feature Request" -description: Suggest a new idea or improvement for this project. -title: "[Feature] " -labels: ["enhancement"] -body: - - type: checkboxes - id: checks - attributes: - label: Preliminary Checks - description: Please ensure you've done the following before submitting a feature request. - options: - - label: I have searched [existing issues](../issues) and [pull requests](../pulls) to avoid duplicates. - required: true - - label: I have read the [contributing guidelines](../blob/main/CONTRIBUTING.md) (if applicable). - required: false - - - type: textarea - id: problem - attributes: - label: Problem Statement - description: Is your feature request related to a problem? Please describe it clearly. - placeholder: | - Ex: I'm always frustrated when [...] - - - type: textarea - id: solution - attributes: - label: Proposed Solution - description: A clear and concise description of what you want to happen. - placeholder: | - Ex: It would be great if [...] - - - type: textarea - id: alternatives - attributes: - label: Alternatives Considered - description: Have you considered any alternative solutions or features? - placeholder: | - Ex: I also thought about [...], but [...] - - - type: textarea - id: context - attributes: - label: Additional Context - description: Add any other context, references, mockups, or screenshots here. - - - type: textarea - id: acceptance - attributes: - label: Acceptance Criteria - description: List specific tasks or outcomes that define when this request is complete. - placeholder: | - - [ ] A new endpoint `/v1/...` is added - - [ ] Docs updated - - [ ] Tests written and passing From 1f3d4e1b3c30286f258a1ce48f8f5cc15c49f573 Mon Sep 17 00:00:00 2001 From: Krishna Waske Date: Thu, 10 Apr 2025 12:57:01 +0530 Subject: [PATCH 05/10] Update FEATURE-REQUEST.md Update FEATURE-REQUEST.md Signed-off-by: Krishna Waske Signed-off-by: Krishna Waske --- .github/ISSUE_TEMPLATE/FEATURE-REQUEST.md | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/ISSUE_TEMPLATE/FEATURE-REQUEST.md b/.github/ISSUE_TEMPLATE/FEATURE-REQUEST.md index 0e151629..4abc3ec8 100644 --- a/.github/ISSUE_TEMPLATE/FEATURE-REQUEST.md +++ b/.github/ISSUE_TEMPLATE/FEATURE-REQUEST.md @@ -2,6 +2,7 @@ - [ ] I have searched [existing issues](../issues) and [pull requests](../pulls) to avoid duplicates. - [ ] I have read the [contributing guidelines](../blob/main/CONTRIBUTING.md) (if applicable). +- [ ] I'm willing to create a PR for this feature. (if applicable). --- From 7746bd26f0db6f066c3f2fe0dd52b9e2bb703818 Mon Sep 17 00:00:00 2001 From: Krishna Waske Date: Thu, 10 Apr 2025 12:57:26 +0530 Subject: [PATCH 06/10] Update BUG-REPORT.md Update BUG-REPORT.md Signed-off-by: Krishna Waske Signed-off-by: Krishna Waske --- .github/ISSUE_TEMPLATE/BUG-REPORT.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/BUG-REPORT.md b/.github/ISSUE_TEMPLATE/BUG-REPORT.md index d9eb2c1d..840999eb 100644 --- a/.github/ISSUE_TEMPLATE/BUG-REPORT.md +++ b/.github/ISSUE_TEMPLATE/BUG-REPORT.md @@ -2,7 +2,7 @@ - [ ] I have searched [existing issues](../issues) and [pull requests](../pulls) for duplicates. - [ ] I have read the [contributing guidelines](../blob/main/CONTRIBUTING.md) (if applicable). -- [ ] I'm willing to create a PR fixing this issuer. (if applicable). +- [ ] I'm willing to create a PR fixing this issue. (if applicable). --- From 5b31dbb803c09b366090ce94562847ec0fa822b8 Mon Sep 17 00:00:00 2001 From: Krishna Waske Date: Thu, 10 Apr 2025 13:29:01 +0530 Subject: [PATCH 07/10] Update FEATURE-REQUEST.md Update FEATURE-REQUEST.md Signed-off-by: Krishna Waske Signed-off-by: Krishna Waske --- .github/ISSUE_TEMPLATE/FEATURE-REQUEST.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/FEATURE-REQUEST.md b/.github/ISSUE_TEMPLATE/FEATURE-REQUEST.md index 4abc3ec8..de921201 100644 --- a/.github/ISSUE_TEMPLATE/FEATURE-REQUEST.md +++ b/.github/ISSUE_TEMPLATE/FEATURE-REQUEST.md @@ -40,6 +40,6 @@ _Add any other context, references, mockups, or screenshots here._ _List specific tasks or outcomes that define when this request is complete._ -- [ ] A new endpoint `/v1/...` is added -- [ ] Docs updated -- [ ] Tests written and passing +- A new endpoint `/v1/...` is added +- Docs updated +- Tests written and passing From 71a61e4ee22e474e535b8603e2e9f49236358a2e Mon Sep 17 00:00:00 2001 From: Krishna Waske Date: Thu, 10 Apr 2025 14:01:20 +0530 Subject: [PATCH 08/10] Update BUG-REPORT.md Update link and remove checks Signed-off-by: Krishna Waske --- .github/ISSUE_TEMPLATE/BUG-REPORT.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/BUG-REPORT.md b/.github/ISSUE_TEMPLATE/BUG-REPORT.md index 840999eb..83e8dec0 100644 --- a/.github/ISSUE_TEMPLATE/BUG-REPORT.md +++ b/.github/ISSUE_TEMPLATE/BUG-REPORT.md @@ -1,7 +1,6 @@ ## ๐Ÿงพ Preliminary Checks -- [ ] I have searched [existing issues](../issues) and [pull requests](../pulls) for duplicates. -- [ ] I have read the [contributing guidelines](../blob/main/CONTRIBUTING.md) (if applicable). +- [ ] 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). --- From 3f1622d625b77a26d0f99eec84fc1f537f322323 Mon Sep 17 00:00:00 2001 From: Krishna Waske Date: Thu, 10 Apr 2025 14:02:05 +0530 Subject: [PATCH 09/10] Update FEATURE-REQUEST.md Update Signed-off-by: Krishna Waske --- .github/ISSUE_TEMPLATE/FEATURE-REQUEST.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/FEATURE-REQUEST.md b/.github/ISSUE_TEMPLATE/FEATURE-REQUEST.md index de921201..fac6d81a 100644 --- a/.github/ISSUE_TEMPLATE/FEATURE-REQUEST.md +++ b/.github/ISSUE_TEMPLATE/FEATURE-REQUEST.md @@ -1,7 +1,6 @@ ## โœ… Preliminary Checks -- [ ] I have searched [existing issues](../issues) and [pull requests](../pulls) to avoid duplicates. -- [ ] I have read the [contributing guidelines](../blob/main/CONTRIBUTING.md) (if applicable). +- [ ] 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). --- From 03abc799fc07a3ad31373984a925f49f4017bc95 Mon Sep 17 00:00:00 2001 From: Krishna Waske Date: Thu, 10 Apr 2025 15:41:36 +0530 Subject: [PATCH 10/10] fix: formating Signed-off-by: Krishna Waske --- .github/ISSUE_TEMPLATE/BUG-REPORT.md | 1 - .github/ISSUE_TEMPLATE/FEATURE-REQUEST.md | 6 +++--- 2 files changed, 3 insertions(+), 4 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/BUG-REPORT.md b/.github/ISSUE_TEMPLATE/BUG-REPORT.md index 83e8dec0..2da1ea2f 100644 --- a/.github/ISSUE_TEMPLATE/BUG-REPORT.md +++ b/.github/ISSUE_TEMPLATE/BUG-REPORT.md @@ -56,4 +56,3 @@ _Where did the issue occur?_ ## ๐Ÿงพ 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 index fac6d81a..bd52e3ed 100644 --- a/.github/ISSUE_TEMPLATE/FEATURE-REQUEST.md +++ b/.github/ISSUE_TEMPLATE/FEATURE-REQUEST.md @@ -39,6 +39,6 @@ _Add any other context, references, mockups, or screenshots here._ _List specific tasks or outcomes that define when this request is complete._ -- A new endpoint `/v1/...` is added -- Docs updated -- Tests written and passing +- A new endpoint `/v1/...` is added +- Docs updated +- Tests written and passing