From 05489a1c563e20a49fe34d4df97ca0c3c23d8634 Mon Sep 17 00:00:00 2001 From: David Perl Date: Fri, 16 May 2025 11:40:06 +0200 Subject: [PATCH] chore: migrate issue template to github form syntax --- .github/ISSUE_TEMPLATE/bug_report.md | 26 ------------ .github/ISSUE_TEMPLATE/bug_report.yml | 41 +++++++++++++++++++ .../ISSUE_TEMPLATE/documentation_update.md | 10 +++++ .github/ISSUE_TEMPLATE/feature_request.md | 5 ++- .../pull_request_template.md | 11 +++-- .../issue_templates/bug_report_template.md | 17 -------- .../feature_request_template.md | 40 ------------------ 7 files changed, 62 insertions(+), 88 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml rename .gitlab/issue_templates/documentation_update_template.md => .github/ISSUE_TEMPLATE/documentation_update.md (84%) rename .gitlab/merge_request_templates/default.md => .github/pull_request_template.md (56%) delete mode 100644 .gitlab/issue_templates/bug_report_template.md delete mode 100644 .gitlab/issue_templates/feature_request_template.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index 7e1a0932..00000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -name: Bug report -about: Create a report to help us improve -title: '' -labels: '' -assignees: '' - ---- - -## Bug report - -## Summary - -[Provide a brief description of the bug.] - -## Expected Behavior vs Actual Behavior - -[Describe what you expected to happen and what actually happened.] - -## Steps to Reproduce - -[Outline the steps that lead to the bug's occurrence. Be specific and provide a clear sequence of actions.] - -## Related Issues - -[Paste links to any related issues or feature requests.] diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 00000000..b68a2965 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,41 @@ +name: Bug report +description: File a bug report. +title: "[BUG]: " +labels: ["bug"] + +body: + - type: markdown + attributes: + value: | + Bug report: + - type: textarea + id: description + attributes: + label: Provide a brief description of the bug. + - type: textarea + id: expected + attributes: + label: Describe what you expected to happen and what actually happened. + - type: textarea + id: reproduction + attributes: + label: Outline the steps that lead to the bug's occurrence. Be specific and provide a clear sequence of actions. + - type: input + id: version + attributes: + label: bec_widgets version + description: which version of BEC widgets was running? + - type: input + id: bec-version + attributes: + label: bec core version + description: which version of BEC core was running? + - type: textarea + id: extra + attributes: + label: Any extra info / data? e.g. log output... + - type: input + id: issues + attributes: + label: Related issues + description: please tag any related issues \ No newline at end of file diff --git a/.gitlab/issue_templates/documentation_update_template.md b/.github/ISSUE_TEMPLATE/documentation_update.md similarity index 84% rename from .gitlab/issue_templates/documentation_update_template.md rename to .github/ISSUE_TEMPLATE/documentation_update.md index 570c7421..cb03f6be 100644 --- a/.gitlab/issue_templates/documentation_update_template.md +++ b/.github/ISSUE_TEMPLATE/documentation_update.md @@ -1,3 +1,13 @@ +--- +name: Documentation update request +about: Suggest an update to the docs +title: '[DOCS]: ' +type: documentation +label: documentation +assignees: '' + +--- + ## Documentation Section [Specify the section or page of the documentation that needs updating] diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index 9eb346a3..0433812c 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -1,8 +1,9 @@ --- name: Feature request about: Suggest an idea for this project -title: '' -labels: '' +title: '[FEAT]: ' +type: feature +label: feature assignees: '' --- diff --git a/.gitlab/merge_request_templates/default.md b/.github/pull_request_template.md similarity index 56% rename from .gitlab/merge_request_templates/default.md rename to .github/pull_request_template.md index fb256d3b..0e56de59 100644 --- a/.gitlab/merge_request_templates/default.md +++ b/.github/pull_request_template.md @@ -1,19 +1,24 @@ ## Description -[Provide a brief description of the changes introduced by this merge request.] +[Provide a brief description of the changes introduced by this pull request.] ## Related Issues -[Cite any related issues or feature requests that are addressed or resolved by this merge request. Use the gitlab syntax for linking issues, for example, `fixes #123` or `closes #123`.] +[Cite any related issues or feature requests that are addressed or resolved by this pull request. Link the associated issue, for example, with `fixes #123` or `closes #123`.] ## Type of Change - Change 1 - Change 2 +## How to test + +- Run unit tests +- Open [widget] in designer and play around with the properties + ## Potential side effects -[Describe any potential side effects or risks of merging this MR.] +[Describe any potential side effects or risks of merging this PR.] ## Screenshots / GIFs (if applicable) diff --git a/.gitlab/issue_templates/bug_report_template.md b/.gitlab/issue_templates/bug_report_template.md deleted file mode 100644 index 5c02a071..00000000 --- a/.gitlab/issue_templates/bug_report_template.md +++ /dev/null @@ -1,17 +0,0 @@ -## Bug report - -## Summary - -[Provide a brief description of the bug.] - -## Expected Behavior vs Actual Behavior - -[Describe what you expected to happen and what actually happened.] - -## Steps to Reproduce - -[Outline the steps that lead to the bug's occurrence. Be specific and provide a clear sequence of actions.] - -## Related Issues - -[Paste links to any related issues or feature requests.] \ No newline at end of file diff --git a/.gitlab/issue_templates/feature_request_template.md b/.gitlab/issue_templates/feature_request_template.md deleted file mode 100644 index 23567774..00000000 --- a/.gitlab/issue_templates/feature_request_template.md +++ /dev/null @@ -1,40 +0,0 @@ -## Feature Summary - -[Provide a brief and clear summary of the new feature you are requesting] - -## Problem Description - -[Explain the problem or need that this feature aims to address. Be specific about the issues or gaps in the current functionality] - -## Use Case - -[Describe a real-world scenario or use case where this feature would be beneficial. Explain how it would improve the user experience or workflow] - -## Proposed Solution - -[If you have a specific solution in mind, describe it here. Explain how it would work and how it would address the problem described above] - -## Benefits - -[Explain the benefits and advantages of implementing this feature. Highlight how it adds value to the product or improves user satisfaction] - -## Alternatives Considered - -[If you've considered alternative solutions or workarounds, mention them here. Explain why the proposed feature is the preferred option] - -## Impact on Existing Functionality - -[Discuss how the new feature might impact or interact with existing features. Address any potential conflicts or dependencies] - -## Priority - -[Assign a priority level to the feature request based on its importance. Use a scale such as Low, Medium, High] - -## Attachments - -[Include any relevant attachments, such as sketches, diagrams, or references that can help the development team understand your feature request better] - -## Additional Information - -[Provide any additional information that might be relevant to the feature request, such as user feedback, market trends, or similar features in other products] -