mirror of
https://github.com/InvoiceShelf/InvoiceShelf.git
synced 2026-04-07 21:44:51 +00:00
b49228eabf
* chore: update issue template Signed-off-by: Rihards Simanovics <rihards.s@griffin-web.studio> * chore: correct spelling in issue template Signed-off-by: Rihards Simanovics <rihards.s@griffin-web.studio> * fix: adjust render for some textarea fields and add a reproduction step * fix: remove render from markdown fields looks like github gets confused as all textarea fields are markdown by the default * style: add comments and correct labels * feat(github): add code quality issue template * refactor: remove direct references to Files From template fields, descriptions, and placeholders * refactor(github): convert feature request template to issue form --------- Signed-off-by: Rihards Simanovics <rihards.s@griffin-web.studio>
74 lines
2.0 KiB
YAML
74 lines
2.0 KiB
YAML
# Big thanks to https://github.com/files-community/Files/ for a template of the code_quality_issue
|
|
|
|
name: Code Quality Issue
|
|
description: Create a code quality issue to help InvoiceShelf keep a clean codebase
|
|
labels:
|
|
- code quality
|
|
- triage
|
|
projects: ["InvoiceShelf/2"]
|
|
assignees:
|
|
- rihards-simanovics
|
|
|
|
body:
|
|
# Tip to warn of checking for existing issues
|
|
- type: markdown
|
|
attributes:
|
|
value: >
|
|
> [!TIP]
|
|
|
|
> Have you checked for similar code quality issues? There's a
|
|
possibility your suggestion is already being tracked. Please do a
|
|
thorough search before creating a new issue.
|
|
|
|
# Issue body
|
|
- type: textarea
|
|
id: description
|
|
attributes:
|
|
label: Description
|
|
description: A clear and concise description of what the code quality issue is.
|
|
validations:
|
|
required: true
|
|
|
|
# Related code
|
|
- type: textarea
|
|
id: code-in-question
|
|
attributes:
|
|
label: The code in question
|
|
description: >-
|
|
A list of the different InvoiceShelf and/or areas of the code concerned by the issue.
|
|
validations:
|
|
required: true
|
|
|
|
# Gains
|
|
- type: textarea
|
|
id: gains
|
|
attributes:
|
|
label: Gains
|
|
description: What would fixing this code quality issue bring to the source code?
|
|
value: |
|
|
- eg. A better readability.
|
|
- eg. Uncoupling concepts X and Y.
|
|
- eg. Clarifying the responsibility of class C.
|
|
validations:
|
|
required: true
|
|
|
|
# Requirements
|
|
- type: textarea
|
|
id: requirements
|
|
attributes:
|
|
label: Requirements
|
|
description: Describe all the requirements to solve the code quality issue.
|
|
value: |
|
|
- eg. Using a specific design pattern.
|
|
- eg. Separating Interface I into three new interfaces I1, I2 and I3.
|
|
- eg. Regrouping the duplicated process into a new helper.
|
|
|
|
# Remarks
|
|
- type: textarea
|
|
id: comments
|
|
attributes:
|
|
label: Comments
|
|
description: >-
|
|
Additional information, comments or screenshots about the code quality
|
|
issue.
|