Adds the new updated ISSUE_TEMPLATE to the support repository of Getbible #18

Merged
Llewellyn merged 12 commits from Lemuel/support:issue_template into master 2024-03-14 08:38:32 +00:00
12 changed files with 938 additions and 0 deletions

View File

@ -0,0 +1,71 @@
name: Default 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: textarea
id: steps_to_reproduce
attributes:
label: Steps to reproduce the Bug
description: Please provide a detailed description of the steps to reproduce the issue you experienced.
placeholder: Describe the steps to reproduce the issue.
value: ""
validations:
required: true
- type: markdown
attributes:
value: |
# Environment Details
- type: textarea
id: environment
attributes:
label: Enviroment in which Bug Occured
description: Please provide a detailed description of the environment in which you experienced the issue.
placeholder: Describe the environment you're in.
value: ""
validations:
required: true
- type: dropdown
id: area
attributes:
label: Which area of Getbible does this bug report relate to?
multiple: true
options:
- loader
- daily-scripture
- daily-light
- joomla-component
- v2_builder
- v2
- api
- librarian
- getverse
- Other
validations:
required: true
- type: textarea
id: where_it_happened
attributes:
label: Where in the above selected area did this issue occur?
description: If applicable, please provide a in depth discription of where the issue occured.
placeholder: Explain in detail where the issue occured
value: ""
- 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,78 @@
name: Default Enhancement Request
about: Suggest an enhancement idea.
title: "[ENHANCEMENT]: "
labels:
- enhancement
body:
- type: markdown
attributes:
value: |
Thank you for suggesting an enhancement! Your input is crucial for our innovation and progress. To assist us better, please share detailed information about your idea.
- type: textarea
id: enhancement-details
attributes:
label: Enhancement Details
description: Could you detail the enhancement you're suggesting? Explain the issue it addresses or the new feature it introduces.
placeholder: Please give an in-depth explanation of your proposed enhancement.
validations:
required: true
- type: markdown
attributes:
value: |
# Context and Priority
- type: textarea
id: environment
attributes:
label: Environment in which this enhancement will function
description: Please provide a detailed description of the environment for which you are proposing this enhancment.
placeholder: Describe the environment applicable.
value: ""
validations:
required: true
- type: dropdown
id: area
attributes:
label: Which area of Getbible does this enhancement request relate to?
multiple: true
options:
- loader
- daily-scripture
- daily-light
- joomla-component
- v2_builder
- v2
- api
- librarian
- getverse
- Other
validations:
required: true
- type: textarea
id: where_it_applies
attributes:
label: Where in the above selected area does this enhancement apply?
description: If applicable, please provide a in depth discription of where enhancement request applies.
placeholder: Explain in detail where it applies.
value: ""
validations:
required: false
- type: textarea
id: benefits
attributes:
label: Expected Benefits
description: What advantages can be anticipated from this enhancement? How does it contribute to the improvement of the system?
placeholder: Detail the advantages that this enhancement will provide.
validations:
required: true
- type: textarea
id: additional-context
attributes:
label: Additional Context
description: Supply additional context or screenshots related to the enhancement request in this space.
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,78 @@
name: Default 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: textarea
id: environment
attributes:
label: Environment for which this task is proposed
description: Please provide a detailed overview of the specific environment for which this task is proposed.
placeholder: Describe the environment applicable.
value: ""
validations:
required: true
- type: dropdown
id: area
attributes:
label: Which area of Getbible does task relate to?
multiple: true
options:
- loader
- daily-scripture
- daily-light
- joomla-component
- v2_builder
- v2
- api
- librarian
- getverse
- Other
validations:
required: true
- type: textarea
id: what_it_impacts
attributes:
label: What area of the above selected options does this task impact?
description: If applicable, please provide a in depth discription of the area that will be impacted by this task.
placeholder: Explain in detail what area the task impacts
value: ""
validations:
required: false
- 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,85 @@
name: Task for the Joomla-Component
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
validations:
required: true
- type: dropdown
id: joomla-component_version
attributes:
label: Which GetBible/joomla-component version is this task related to?
multiple: true
options:
- v5.x
- v4.x
- v3.x
- Other
validations:
required: true
- type: dropdown
id: area
attributes:
label: Which area of the component does this task relate to?
multiple: true
options:
- Linkers(admin_views)
- Notes(admin_views)
- Tagged Verses(admin_views)
- Prompts(admin_views)
- Open AI Responses(admin_views)
- Tags(admin_views)
- Translations(admin_views)
- Books(admin_views)
- Chapters(admin_views)
- Verses(admin_views)
- App(site_vew)
- 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,77 @@
name: Default 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: textarea
id: environment
attributes:
label: Environment for which this documentation is proposed
description: Please provide a detailed overview of the specific environment for which this documentation is proposed.
placeholder: Describe the environment applicable.
value: ""
validations:
required: true
- type: dropdown
id: area
attributes:
label: Which area of Getbible does this documentation relate to?
multiple: true
options:
- loader
- daily-scripture
- daily-light
- joomla-component
- v2_builder
- v2
- api
- librarian
- getverse
- Other
validations:
required: true
- type: textarea
id: area_concern
attributes:
label: What area of the above selected options does this documentation concern?
description: If applicable, specify the particular areas or processes directly related to or covered by this documentation
placeholder: Detail the areas requiring documentation.
validations:
required: false
- 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,85 @@
name: Documentation for the Joomla-Component
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
validations:
required: true
- type: dropdown
id: joomla-component_version
attributes:
label: Which GetBible/joomla-component version is this documentation related to?
multiple: true
options:
- v5.x
- v4.x
- v3.x
- Other
validations:
required: true
- type: dropdown
id: area
attributes:
label: Which area of the component does this documentation relate to?
multiple: true
options:
- Linkers(admin_views)
- Notes(admin_views)
- Tagged Verses(admin_views)
- Prompts(admin_views)
- Open AI Responses(admin_views)
- Tags(admin_views)
- Translations(admin_views)
- Books(admin_views)
- Chapters(admin_views)
- Verses(admin_views)
- App(site_vew)
- 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,120 @@
name: Default Performance Issue
about: Recommend or propose performance improvements
title: "[PERFORMANCE]: "
labels:
- performance
body:
- type: markdown
attributes:
value: |
Appreciation for tackling performance challenges! Optimizing performance is vital for our system's efficiency and the user experience. Could you offer more comprehensive details to aid in identifying and resolving the suggested performance issue or improvement?
- type: textarea
id: performance-details
attributes:
label: Performance Details
description: Please outline the performance problem or the enhancements you propose. Is it related to speed, resource usage, responsiveness, or something else?
placeholder: Offer an in-depth explanation of the performance challenge or improvement.
validations:
required: true
- type: markdown
attributes:
value: |
# Affected Systems and Context
- type: textarea
id: environment
attributes:
label: Environment in which this performance issue occures.
description: Please provide a detailed overview of the specific environment in which this performance issue occures.
placeholder: Describe the environment applicable.
value: ""
validations:
required: true
- type: dropdown
id: area
attributes:
label: Which area of Getbible is affected by this performance issue?
multiple: true
options:
- loader
- daily-scripture
- daily-light
- joomla-component
- v2_builder
- v2
- api
- librarian
- getverse
- Other
validations:
required: true
- type: textarea
id: area_concern
attributes:
label: What area of the above selected options does this performance issue relate to?
description: If applicable, specify the particular areas or processes directly related to or affected by this preformance issue.
placeholder: Detail the areas affected.
validations:
required: false
- type: dropdown
id: browsers
attributes:
label: Which browsers did you experience the performance problem on?
multiple: true
options:
- Chrome
- Firefox
- Microsoft Edge
- Safari
- Opera
- Brave
- Vivaldi
validations:
required: true
- type: dropdown
id: os
attributes:
label: Which operating system are you using?
multiple: true
options:
- Linux
- Windows
- macOS
- Other
validations:
required: true
- type: textarea
id: replication-steps
attributes:
label: Steps to Replicate
description: If possible, share a step-by-step guide to replicate the performance problem.
placeholder: Explain how to replicate the problem.
validations:
required: false
- type: textarea
id: impact-assessment
attributes:
label: Impact Assessment
description: How does the performance problem impact the system or its users? How severe is its effect?
placeholder: Explain the impact of the performance problem.
validations:
required: true
- type: textarea
id: proposed-solutions
attributes:
label: Proposed Solutions or Ideas
description: If you have any suggestions or ideas for resolving the performance problem, please share them here.
placeholder: Share any potential solutions or improvement problem.
validations:
required: false
- type: textarea
id: additional-context
attributes:
label: Additional Context
description: Provide any additional context, benchmarks, logs, or screenshots that might help in understanding or addressing the performance problem.
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,77 @@
name: Default 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: textarea
id: environment
attributes:
label: Environment for which this refactoring task applies.
description: Please provide a detailed overview of the specific environment for which this refactoring task applies.
placeholder: Describe the environment applicable.
value: ""
validations:
required: true
- type: dropdown
id: area
attributes:
label: Which area of Getbible will be affected by this refactoring task?
multiple: true
options:
- loader
- daily-scripture
- daily-light
- joomla-component
- v2_builder
- v2
- api
- librarian
- getverse
- Other
validations:
required: true
- type: textarea
id: part_affected
attributes:
label: Which area of the above selected options will be impacted by this refactoring?
description: If applicable, please provide details on which specific area or component of the system will be impacted by this refactoring?
placeholder: Detail the areas affected by this refactoring
validations:
required: false
- 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,85 @@
name: Refactoring Task for the Joomla-Component
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
validations:
required: true
- type: dropdown
id: joomla-component_version
attributes:
label: Which GetBible/joomla-component version is this refactoring related to?
multiple: true
options:
- v5.x
- v4.x
- v3.x
- Other
validations:
required: true
- type: dropdown
id: area
attributes:
label: Which area of the component will be impacted by this refactoring task?
multiple: true
options:
- Linkers(admin_views)
- Notes(admin_views)
- Tagged Verses(admin_views)
- Prompts(admin_views)
- Open AI Responses(admin_views)
- Tags(admin_views)
- Translations(admin_views)
- Books(admin_views)
- Chapters(admin_views)
- Verses(admin_views)
- App(site_vew)
- 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,53 @@
name: Default 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].
- 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: area_affected
attributes:
label: Which area of Getbible could potentially be affected?
multiple: true
options:
- loader
- daily-scripture
- daily-light
- joomla-component
- v2_builder
- v2
- api
- librarian
- getverse
- 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.

View File

@ -0,0 +1,60 @@
name: Security Issue for the Joomla-Component
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].
- 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: joomla_version
attributes:
label: Which Joomla version could potentially be affected?
multiple: true
options:
- Joomla 5
- Joomla 4
- Joomla 3
- All
validations:
required: true
- type: dropdown
id: joomla-component_version
attributes:
label: Which GetBible/joomla-component version could potentially be affected?
multiple: true
options:
- v5.x
- v4.x
- v3.x
- 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.

View File

@ -0,0 +1,69 @@
name: Default Test Issue
about: Recommend additional assessments or identify any problems with current tests.
title: "[TEST]: "
labels:
- test
body:
- type: markdown
attributes:
value: |
Thank you for your involvement in the testing phase of our initiative! Thorough testing is essential to uphold the integrity and dependability of our systems. Please provide detailed information to aid us in comprehending the testing activity or problem you're proposing or highlighting.
- type: textarea
id: testing-details
attributes:
label: Testing Details
description: Could you specify the testing task or concern? Are you proposing a new test, pointing out a defect in current tests, or identifying untested areas?
placeholder: Please offer an detailed description of the testing task or issue.
validations:
required: true
- type: markdown
attributes:
value: |
# Affected Components and Context
- type: textarea
id: environment
attributes:
label: Environment for which this testing task applies.
description: Please provide a detailed overview of the specific environment for which this testing task applies.
placeholder: Describe the environment applicable.
value: ""
validations:
required: true
- type: dropdown
id: area
attributes:
label: Which area of Getbible will affected by this testing task?
multiple: true
options:
- loader
- daily-scripture
- daily-light
- joomla-component
- v2_builder
- v2
- api
- librarian
- getverse
- Other
validations:
required: true
- type: textarea
id: expected-outcome
attributes:
label: Expected Outcome
description: What do you expect to achieve with this testing task? How will it improve the system or its reliability?
placeholder: Describe the expected outcome of this testing task.
validations:
required: true
- type: textarea
id: additional-context
attributes:
label: Additional Context
description: Provide any additional context, testing scenarios, or information that might help in understanding or implementing the testing 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.