From ca4d5ea64f86cbdc3f559fd730241e82d2936e6d Mon Sep 17 00:00:00 2001 From: AHReccese Date: Wed, 22 Jan 2025 11:35:13 -0500 Subject: [PATCH 1/4] remove previous issue template --- .github/ISSUE_TEMPLATE.md | 13 ------------- 1 file changed, 13 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE.md diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md deleted file mode 100644 index 79f6362..0000000 --- a/.github/ISSUE_TEMPLATE.md +++ /dev/null @@ -1,13 +0,0 @@ -#### Description - -#### Steps/Code to Reproduce - -#### Expected Behavior - -#### Actual Behavior - -#### Operating System - -#### Python Version - -#### DMeta Version (Use : `dmeta.__version__`) From 2ec8649f84ae0a98a28ad27fb041e59a4ac3f47d Mon Sep 17 00:00:00 2001 From: AHReccese Date: Wed, 22 Jan 2025 11:35:42 -0500 Subject: [PATCH 2/4] add new issue template --- .github/ISSUE_TEMPLATE/bug_report.yml | 100 +++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 8 ++ .github/ISSUE_TEMPLATE/feature_request.yml | 36 ++++++++ 3 files changed, 144 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yml diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 0000000..e0ca8cf --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,100 @@ +name: Bug Report +description: File a bug report +title: "[Bug]: " +body: + - type: markdown + attributes: + value: | + Thanks for your time to fill out this bug report! + - type: input + id: contact + attributes: + label: Contact details + description: How can we get in touch with you if we need more info? + placeholder: ex. email@example.com + validations: + required: false + - type: textarea + id: what-happened + attributes: + label: What happened? + description: Provide a clear and concise description of what the bug is. + placeholder: > + Tell us a description of the bug. + validations: + required: true + - type: textarea + id: step-to-reproduce + attributes: + label: Steps to reproduce + description: Provide details of how to reproduce the bug. + placeholder: > + ex. 1. Go to '...' + validations: + required: true + - type: textarea + id: expected-behavior + attributes: + label: Expected behavior + description: What did you expect to happen? + placeholder: > + ex. I expected '...' to happen + validations: + required: true + - type: textarea + id: actual-behavior + attributes: + label: Actual behavior + description: What did actually happen? + placeholder: > + ex. Instead '...' happened + validations: + required: true + - type: dropdown + id: operating-system + attributes: + label: Operating system + description: Which operating system are you using? + options: + - Windows + - macOS + - Linux + default: 0 + validations: + required: true + - type: dropdown + id: python-version + attributes: + label: Python version + description: Which version of Python are you using? + options: + - Python 3.13 + - Python 3.12 + - Python 3.11 + - Python 3.10 + - Python 3.9 + - Python 3.8 + - Python 3.7 + - Python 3.6 + - Python 3.5 + default: 1 + validations: + required: true + - type: dropdown + id: dmeta-version + attributes: + label: PyMilo version + description: Which version of DMeta are you using? + options: + - DMeta 0.3 + - DMeta 0.2 + - DMeta 0.1 + default: 0 + validations: + required: true + - type: textarea + id: logs + attributes: + label: Relevant log output + description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks. + render: shell diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..ba0335a --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,8 @@ +blank_issues_enabled: false +contact_links: + - name: Discord + url: https://discord.com/invite/mtuMS8AjDS + about: Ask questions and discuss with other DMeta community members + - name: Website + url: https://openscilab.com/ + about: Check out our website for more information diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 0000000..305d2f8 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,36 @@ +name: Feature Request +description: Suggest a feature for this project +title: "[Feature]: " +body: + - type: textarea + id: description + attributes: + label: Describe the feature you want to add + placeholder: > + I'd like to be able to [...] + validations: + required: true + - type: textarea + id: possible-solution + attributes: + label: Describe your proposed solution + placeholder: > + I think this could be done by [...] + validations: + required: false + - type: textarea + id: alternatives + attributes: + label: Describe alternatives you've considered, if relevant + placeholder: > + Another way to do this would be [...] + validations: + required: false + - type: textarea + id: aditional-context + attributes: + label: Additional context + placeholder: > + Add any other context or screenshots about the feature request here. + validations: + required: false From ee922b2530462f33250421d18ec0fb84c074fd0a Mon Sep 17 00:00:00 2001 From: AHReccese Date: Wed, 22 Jan 2025 11:36:34 -0500 Subject: [PATCH 3/4] `CHANGELOG.md` updated --- CHANGELOG.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index dc83c98..16d1d78 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,6 +5,10 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html). ## [Unreleased] +### Added +- modern issue template structure +### Removed +- old issue template structure ## [0.3] - 2025-01-13 ### Removed - `extract_namespaces` function in `util.py` From 39fe15ea9f49d02fcba600a231d511d1ad87a35d Mon Sep 17 00:00:00 2001 From: AHReccese Date: Wed, 22 Jan 2025 16:53:09 -0500 Subject: [PATCH 4/4] apply feedbacks --- .github/ISSUE_TEMPLATE/bug_report.yml | 2 +- .github/ISSUE_TEMPLATE/feature_request.yml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index e0ca8cf..74f9723 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -83,7 +83,7 @@ body: - type: dropdown id: dmeta-version attributes: - label: PyMilo version + label: DMeta version description: Which version of DMeta are you using? options: - DMeta 0.3 diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml index 305d2f8..139114c 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.yml +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -27,7 +27,7 @@ body: validations: required: false - type: textarea - id: aditional-context + id: additional-context attributes: label: Additional context placeholder: >