From cb2cce53268fdd18388a51a53577577dceeaa44f Mon Sep 17 00:00:00 2001 From: Ashtin <137578700+slammingprogramming@users.noreply.github.com> Date: Wed, 25 Jun 2025 05:17:34 -0400 Subject: [PATCH] Add more issue templates Adds templates for enhancements to differentiate enhancing existing features and adding whole new ones. Refactor/Code quality is mostly for dev/contributor use for doc purposes. Security report is essential and also directs them to reach out with sensitive details directly Translation requests added to allow additional accessibility to be requested as-needed and to allow prioritization based on need. --- .../ISSUE_TEMPLATE/enhancement-request.yml | 33 +++++++++++++++++ .../refactor-codequality-request.yml | 37 +++++++++++++++++++ .github/ISSUE_TEMPLATE/security-report.yml | 28 ++++++++++++++ .../ISSUE_TEMPLATE/translation-request.yml | 36 ++++++++++++++++++ 4 files changed, 134 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/enhancement-request.yml create mode 100644 .github/ISSUE_TEMPLATE/refactor-codequality-request.yml create mode 100644 .github/ISSUE_TEMPLATE/security-report.yml create mode 100644 .github/ISSUE_TEMPLATE/translation-request.yml diff --git a/.github/ISSUE_TEMPLATE/enhancement-request.yml b/.github/ISSUE_TEMPLATE/enhancement-request.yml new file mode 100644 index 00000000..40ac5d0e --- /dev/null +++ b/.github/ISSUE_TEMPLATE/enhancement-request.yml @@ -0,0 +1,33 @@ +name: Enhancement Request +description: Propose an improvement to an existing feature or UX behavior. +labels: ['enhancement ♻️'] +body: +- type: checkboxes + attributes: + label: Is there an existing issue for this? + options: + - label: I have searched existing open and closed issues + required: true +- type: textarea + attributes: + label: What is the enhancement? + description: Describe the change or optimization you’d like to see to an existing feature. + placeholder: e.g. Make scan intervals configurable from UI instead of just `app.conf` + required: true +- type: textarea + attributes: + label: What problem does this solve or improve? + description: Describe why this change would improve user experience or project maintainability. + required: true +- type: textarea + attributes: + label: Additional context or examples + description: | + Screenshots? Comparisons? Reference repos? + required: false +- type: checkboxes + attributes: + label: Are you willing to help implement this? + options: + - label: "Yes" + - label: "No" diff --git a/.github/ISSUE_TEMPLATE/refactor-codequality-request.yml b/.github/ISSUE_TEMPLATE/refactor-codequality-request.yml new file mode 100644 index 00000000..432d2aad --- /dev/null +++ b/.github/ISSUE_TEMPLATE/refactor-codequality-request.yml @@ -0,0 +1,37 @@ +name: Refactor / Code Quality Request ♻️ +description: Suggest improvements to code structure, style, or maintainability. +labels: ['enhancement ♻️'] +body: +- type: checkboxes + attributes: + label: Is there an existing issue for this? + description: Please check if a similar request already exists. + options: + - label: I have searched the existing open and closed issues + required: true +- type: textarea + attributes: + label: What part of the code needs refactoring or improvement? + description: Specify files, modules, or components. + required: true +- type: textarea + attributes: + label: Describe the proposed changes + description: Explain the refactoring or quality improvements you suggest. + required: true +- type: textarea + attributes: + label: Why is this improvement needed? + description: Benefits such as maintainability, readability, performance, or scalability. + required: true +- type: textarea + attributes: + label: Additional context or examples + description: Any relevant links, references, or related issues. + required: false +- type: checkboxes + attributes: + label: Can you help implement this change? + options: + - label: Yes + - label: No diff --git a/.github/ISSUE_TEMPLATE/security-report.yml b/.github/ISSUE_TEMPLATE/security-report.yml new file mode 100644 index 00000000..6653dd92 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/security-report.yml @@ -0,0 +1,28 @@ +name: Security Report 🔐 +description: Report a security vulnerability or concern privately. +labels: ['security 🔐'] +body: +- type: markdown + attributes: + value: | + **Important:** For security reasons, please do **not** post sensitive security issues publicly in the issue tracker. + Instead, send details to our security contact email: [jokob@duck.com](mailto:jokob@duck.com). + + We appreciate your responsible disclosure. +- type: textarea + attributes: + label: Brief summary (non-sensitive) + description: Provide a non-sensitive overview of the security issue. + required: true +- type: textarea + attributes: + label: Additional context or references + description: Any other information or related reports. + required: false +- type: checkboxes + attributes: + label: Have you sent this report via email to the security contact? + options: + - label: Yes, I have sent the details to jokob@duck.com + required: true + - label: Not yet, I will send it after opening this issue diff --git a/.github/ISSUE_TEMPLATE/translation-request.yml b/.github/ISSUE_TEMPLATE/translation-request.yml new file mode 100644 index 00000000..f936f51b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/translation-request.yml @@ -0,0 +1,36 @@ +name: Translation / Localization Request 🌐 +description: Suggest adding or improving translations or localization support. +labels: ['enhancement 🌐'] +body: +- type: checkboxes + attributes: + label: Have you checked for existing translation efforts or related issues? + options: + - label: I have searched existing open and closed issues + required: true +- type: textarea + attributes: + label: Language(s) involved + description: Specify the language(s) this request pertains to. + required: true +- type: textarea + attributes: + label: Describe the translation or localization improvement + description: Examples include adding new language support, fixing translation errors, or improving formatting. + required: true +- type: textarea + attributes: + label: Why is this important for the project or users? + description: Describe the benefits or target audience. + required: false +- type: textarea + attributes: + label: Additional context or references + description: Link to files, previous translation PRs, or external resources. + required: false +- type: checkboxes + attributes: + label: Can you help with translation or review? + options: + - label: Yes + - label: No