support/.gitea/ISSUE_TEMPLATE/f-refactor-4-default.yml

78 lines
2.9 KiB
YAML
Raw Normal View History

2024-03-13 08:10:59 +00:00
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.