From 26ae45a46fd381e989b200677085ed14c99925e2 Mon Sep 17 00:00:00 2001 From: Lemuel van der Merwe Date: Tue, 5 Mar 2024 08:41:34 +0200 Subject: [PATCH] Adds ISSUE_TEMPLATE --- support/.gitea/ISSUE_TEMPLATE/a-bug.yml | 96 ++++++++++++++++++++ support/.gitea/ISSUE_TEMPLATE/c-task.yml | 83 +++++++++++++++++ support/.gitea/ISSUE_TEMPLATE/d-doc.yml | 83 +++++++++++++++++ support/.gitea/ISSUE_TEMPLATE/f-refactor.yml | 86 ++++++++++++++++++ support/.gitea/ISSUE_TEMPLATE/g-security.yml | 48 ++++++++++ 5 files changed, 396 insertions(+) create mode 100644 support/.gitea/ISSUE_TEMPLATE/a-bug.yml create mode 100644 support/.gitea/ISSUE_TEMPLATE/c-task.yml create mode 100644 support/.gitea/ISSUE_TEMPLATE/d-doc.yml create mode 100644 support/.gitea/ISSUE_TEMPLATE/f-refactor.yml create mode 100644 support/.gitea/ISSUE_TEMPLATE/g-security.yml diff --git a/support/.gitea/ISSUE_TEMPLATE/a-bug.yml b/support/.gitea/ISSUE_TEMPLATE/a-bug.yml new file mode 100644 index 00000000..bfe0458d --- /dev/null +++ b/support/.gitea/ISSUE_TEMPLATE/a-bug.yml @@ -0,0 +1,96 @@ +name: Bug Report +about: Draft a report to aid in our Debugging efforts. +title: "[BUG]: " +labels: + - bug +body: + - type: markdown + attributes: + value: | + We value your effort in reporting an bug! Your feedback is essential for us to address and fix the problem. + - type: textarea + id: what-happened + attributes: + label: What Happened? + description: Please provide a detailed description of the issue and explain what outcome you anticipate. + placeholder: Describe the issue you experienced. + value: "" + validations: + required: true + - type: markdown + attributes: + value: | + # Environment Details + - type: dropdown + id: system + attributes: + label: Which Joomla version were you using? + multiple: true + options: + - Joomla 5 + - Joomla 4 + - Joomla 3 + - Other + validations: + required: true + - type: dropdown + id: area + attributes: + label: Where did this issue occur? + multiple: true + options: + - Dashboard(admin_view) + - Preachers(admin_views) + - Preacher(admin_view) + - Sermons(admin_views) + - Sermon(admin_view) + - Sermon Categories(admin_views) + - Series List(admin_views) + - Series(admin_view) + - Statistics(admin_view) + - External Sources(admin_views) + - External Source(admin_view) + - Manual Updater(admin_view) + - Local Listings(admin_views) + - Help Documents(admin_views) + - Categories(site_views) + - Category(site_view) + - Preachers(site_views) + - Preacher(site_view) + - Series(site_view) + - Series List(site_views) + - Other + validations: + required: true + - type: dropdown + id: browsers + attributes: + label: On which browsers did you encounter the issue? + multiple: true + options: + - Chrome + - Firefox + - Microsoft Edge + - Safari + - Opera + - Brave + - Vivaldi + validations: + required: true + - type: dropdown + id: os + attributes: + label: What operating system are you currently using? + multiple: true + options: + - Windows (Desktop) + - macOS (Desktop) + - Linux (Desktop) + - Other + validations: + required: true + - type: textarea + id: comments + attributes: + label: Additional Comments + description: Feel free to include any further comments or pertinent details that might assist us. diff --git a/support/.gitea/ISSUE_TEMPLATE/c-task.yml b/support/.gitea/ISSUE_TEMPLATE/c-task.yml new file mode 100644 index 00000000..3f1e3223 --- /dev/null +++ b/support/.gitea/ISSUE_TEMPLATE/c-task.yml @@ -0,0 +1,83 @@ +name: Task +about: Create a task for project management +title: "[TASK]: " +labels: + - task +body: + - type: markdown + attributes: + value: | + Thanks for setting up the task! Tasks assist us in arranging and ranking our work. Kindly provide comprehensive details about the task for clarity and efficient tracking. + - type: textarea + id: task-details + attributes: + label: Task Details + description: Please describe the task. What are the specific actions required? + placeholder: Provide a detailed description of the task. + validations: + required: true + - type: markdown + attributes: + value: | + # Task Context and Priority + - type: dropdown + id: system + attributes: + label: Which Joomla version is this task related to? + multiple: true + options: + - Joomla 5 + - Joomla 4 + - Joomla 3 + - Other + validations: + required: true + - type: dropdown + id: area + attributes: + label: Which area of the system does this task impact? + multiple: true + options: + - Dashboard(admin_view) + - Preachers(admin_views) + - Preacher(admin_view) + - Sermons(admin_views) + - Sermon(admin_view) + - Sermon Categories(admin_views) + - Series List(admin_views) + - Series(admin_view) + - Statistics(admin_view) + - External Sources(admin_views) + - External Source(admin_view) + - Manual Updater(admin_view) + - Local Listings(admin_views) + - Help Documents(admin_views) + - Categories(site_views) + - Category(site_view) + - Preachers(site_views) + - Preacher(site_view) + - Series(site_view) + - Series List(site_views) + - Other + validations: + required: true + - type: textarea + id: task-objective + attributes: + label: Task Objective + description: What's the aim or purpose of this task? How will it contribute to the project or system's success? + placeholder: Describe the goal and anticipated result of the task. + validations: + required: true + - type: textarea + id: additional-context + attributes: + label: Additional Context + description: Please share any extra context, files, or screenshots that could aid in comprehending or carrying out the task. + validations: + required: false + - type: textarea + id: comments + attributes: + label: Additional Comments + description: Feel free to include any further comments or pertinent details that might assist us. diff --git a/support/.gitea/ISSUE_TEMPLATE/d-doc.yml b/support/.gitea/ISSUE_TEMPLATE/d-doc.yml new file mode 100644 index 00000000..bab5e35b --- /dev/null +++ b/support/.gitea/ISSUE_TEMPLATE/d-doc.yml @@ -0,0 +1,83 @@ +name: Documentation +about: Propose improvements to the documentation or highlight any issues found within it. +title: "[DOCUMENTATION]: " +labels: + - documentation +body: + - type: markdown + attributes: + value: | + We appreciate your input on our documentation! Clear and comprehensive documentation plays a vital role in enabling users to effectively interact with our systems. To assist us in making improvements, kindly offer thorough details regarding your suggestion or the specific problem you've encountered. + - type: textarea + id: documentation-details + attributes: + label: Documentation Details + description: Please explain the specific problem with the documentation or the improvements you recommend. Is it a missing topic, unclear instructions, outdated content, or something else? + placeholder: Detail the issue with the documentation or suggest improvements.. + validations: + required: true + - type: markdown + attributes: + value: | + # Specific Context + - type: dropdown + id: system + attributes: + label: Which Joomla version does this documentation relate to? + multiple: true + options: + - Joomla 5 + - Joomla 4 + - Joomla 3 + - Other + validations: + required: true + - type: dropdown + id: area + attributes: + label: Which area of the system does this documentation concern? + multiple: true + options: + - Dashboard(admin_view) + - Preachers(admin_views) + - Preacher(admin_view) + - Sermons(admin_views) + - Sermon(admin_view) + - Sermon Categories(admin_views) + - Series List(admin_views) + - Series(admin_view) + - Statistics(admin_view) + - External Sources(admin_views) + - External Source(admin_view) + - Manual Updater(admin_view) + - Local Listings(admin_views) + - Help Documents(admin_views) + - Categories(site_views) + - Category(site_view) + - Preachers(site_views) + - Preacher(site_view) + - Series(site_view) + - Series List(site_views) + - Other + validations: + required: true + - type: textarea + id: expected-outcome + attributes: + label: Expected Outcome + description: What outcomes do you anticipate from this change in documentation? How will it benifit the users or enhance the project? + placeholder: Explain the expected result of this change in the documentation. + validations: + required: true + - type: textarea + id: additional-context + attributes: + label: Additional Context + description: Share any extra details, files, or screenshots that could help in understanding or applying the documentation change. + validations: + required: false + - type: textarea + id: comments + attributes: + label: Additional Comments + description: Feel free to include any further comments or pertinent details that might assist us. diff --git a/support/.gitea/ISSUE_TEMPLATE/f-refactor.yml b/support/.gitea/ISSUE_TEMPLATE/f-refactor.yml new file mode 100644 index 00000000..c550d2a0 --- /dev/null +++ b/support/.gitea/ISSUE_TEMPLATE/f-refactor.yml @@ -0,0 +1,86 @@ +name: Refactoring Task +about: Recommend or identify the necessity for code refactoring. +title: "[REFACTOR]: " +labels: + - refactor +body: + - type: markdown + attributes: + value: | + We appreciate your commitment to enhancing the maintainability and quality of our codebase! Code refactoring plays a crucial role in ensuring our system remains efficient and easy to manage. To assist us effectively, please share comprehensive details about the refactoring task you are suggesting or identifying. + - type: textarea + id: refactoring-details + attributes: + label: Refactoring Details + description: Outline the refactoring task, specifying which code segment requires attention and the reasons behind this need. What improvements are expected from this refactoring? + placeholder: Provide an in-depth explanation of the refactoring task? + validations: + required: true + - type: markdown + attributes: + value: | + # Affected Components and Context + - type: dropdown + id: system + attributes: + label: Which Joomla version does this refactoring task relate to? + multiple: true + options: + - Joomla 5 + - Joomla 4 + - Joomla 3 + - Other + validations: + required: true + - type: dropdown + id: area + attributes: + label: Which area of the system will be impacted by this refactoring? + multiple: true + options: + - Dashboard(admin_view) + - Preachers(admin_views) + - Preacher(admin_view) + - Sermons(admin_views) + - Sermon(admin_view) + - Sermon Categories(admin_views) + - Series List(admin_views) + - Series(admin_view) + - Statistics(admin_view) + - External Sources(admin_views) + - External Source(admin_view) + - Manual Updater(admin_view) + - Local Listings(admin_views) + - Help Documents(admin_views) + - Categories(site_views) + - Category(site_view) + - Preachers(site_views) + - Preacher(site_view) + - Series(site_view) + - Series List(site_views) + - Back-end (Just Code) + - Front-end (Just GUI) + - All + - Other + validations: + required: true + - type: textarea + id: expected-outcome + attributes: + label: Expected Outcome + description: What benefits do you anticipate from this refactoring? How will it enhance the codebase or overall system? + placeholder: Explain the expected results of this refactoring. + validations: + required: true + - type: textarea + id: additional-context + attributes: + label: Additional Context + description: Share any further details or information, like code snippets, that could aid in comprehending or executing the refactoring task. + validations: + required: false + - type: textarea + id: comments + attributes: + label: Additional Comments + description: Feel free to include any further comments or pertinent details that might assist us. diff --git a/support/.gitea/ISSUE_TEMPLATE/g-security.yml b/support/.gitea/ISSUE_TEMPLATE/g-security.yml new file mode 100644 index 00000000..3230c9c2 --- /dev/null +++ b/support/.gitea/ISSUE_TEMPLATE/g-security.yml @@ -0,0 +1,48 @@ +name: Security Issue +about: Identify a possible security risk. +title: "[SECURITY]: " +labels: + - security +body: + - type: markdown + attributes: + value: | + **⚠️ CRITICAL: Avoid sharing any sensitive or confidential details in this message.** Should you suspect a security flaw, please contact us directly at [example@abc.io]. + - type: textarea + id: security-general-description + attributes: + label: General Description + description: Offer a broad overview of the security concern, ensuring not to disclose any sensitive information. + placeholder: Provide a general description of the security problem. + validations: + required: true + - type: markdown + attributes: + value: | + # Affected Systems + - type: dropdown + id: system + attributes: + label: Which system could potentially be affected? + multiple: true + options: + - Joomla 5 + - Joomla 4 + - Joomla 3 + - All + - Other + validations: + required: true + - type: textarea + id: non-sensitive-details + attributes: + label: Non-Sensitive Details + description: If applicable, please offer further non-sensitive information or general observations regarding the security concern. + placeholder: Provide any relevant non-sensitive details or observations. + validations: + required: false + - type: textarea + id: comments + attributes: + label: Additional Comments + description: Feel free to include any further comments or pertinent details that might assist us.