Adds the ISSUE_TEMPLATE #39

Merged
Llewellyn merged 2 commits from :issue_template into 5.0 2024-03-05 10:01:52 +00:00
5 changed files with 396 additions and 0 deletions

View File

@ -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
Llewellyn marked this conversation as resolved
Review

Please fix this indentation.

Please fix this indentation.
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.

View File

@ -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 extension does this task impact?
multiple: true
options:
- Dashboard(admin_view)
Llewellyn marked this conversation as resolved Outdated

Your indentation seems to be mixed...

Your indentation seems to be mixed...
- 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.

View File

@ -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 extension 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.

View File

@ -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 extension 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.

View File

@ -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 [joomla@vdm.io].
Llewellyn marked this conversation as resolved Outdated

Please add the correct email here.

Please add the correct email here.
- 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 Joomla version 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.