Skip to content

Commit

Permalink
chore: added issue templates
Browse files Browse the repository at this point in the history
  • Loading branch information
c0rydoras committed May 7, 2024
1 parent eee3ebb commit ea69897
Show file tree
Hide file tree
Showing 7 changed files with 232 additions and 59 deletions.
68 changes: 68 additions & 0 deletions .github/ISSUE_TEMPLATE/bug.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
---
name: Bug
description: Report a bug.
title: "[BUG]: "
labels:
- bug
body:
- type: markdown
attributes:
value: |
> [!WARNING]
> If the bug affects security, submit a [security advisory](https://github.com/adfinis/timed/security/advisories/new).
- type: textarea
id: description
validations:
required: true
attributes:
label: Description
description: Briefly describe the bug you encountered.
placeholder: Unable to do X when condition Y...
- type: textarea
id: reproduction
validations:
required: true
attributes:
label: Steps to Reproduce
description: Provide clear steps to reproduce the bug.
placeholder: |
1. Go to X
2. Click the Y button
3. Perform Z action
4. Receive error message
- type: textarea
id: expected-behavior
validations:
required: true
attributes:
label: Expected Behavior
description: Describe what you expected to happen.
- type: textarea
id: attachments
validations:
required: false
attributes:
label: Attachments
description: Attach any relevant screenshots or screen recordings.
- type: textarea
id: extra-context
validations:
required: false
attributes:
label: Additional Context
description: Include any extra details about the bug here.
- type: input
id: version
validations:
required: true
attributes:
label: Version
description: Version of the project where you encountered the bug.
placeholder: vX.Y.Z
- type: checkboxes
attributes:
label: "Required"
description: "Please confirm:"
options:
- label: "I have checked past issues to see if this bug has already been reported."
required: true
43 changes: 43 additions & 0 deletions .github/ISSUE_TEMPLATE/enhancement.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
---
name: Enhancement
description: Propose an enhancement to the project.
title: "[ENHANCEMENT]: "
labels:
- enhancement
body:
- type: markdown
attributes:
value: |
> [!WARNING]
> Remember, an enhancement is not a new feature.
- type: textarea
id: proposed-enhancement
validations:
required: true
attributes:
label: Your proposed enhancement
description: Briefly outline your proposal to enhance this project.
placeholder: Describe your enhancement proposal here...
- type: textarea
id: enhancement-impact
validations:
required: true
attributes:
label: Enhancement Impact
description: How will this enhancement improve the project?
placeholder: Describe the impact of your enhancement here...
- type: textarea
id: additional-context
validations:
required: false
attributes:
label: Additional context
description: Provide any extra details or context about the enhancement here.
placeholder: Add any relevant context or details here...
- type: checkboxes
attributes:
label: "Required"
description: "Please confirm:"
options:
- label: "I have checked past issues to ensure that this isn't a duplicate."
required: true
50 changes: 50 additions & 0 deletions .github/ISSUE_TEMPLATE/feature.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
---
name: Feature
description: Describe a feature that you want implemented.
title: "[FEATURE]: "
labels:
- feature
body:
- type: textarea
id: problem-description
validations:
required: true
attributes:
label: Is your feature request related to a problem? Please describe.
description: A clear and concise description of what the problem is.
placeholder: Describe the problem you are facing...

- type: textarea
id: solution-description
validations:
required: true
attributes:
label: Describe the solution you'd like
description: A clear and concise description of what you want to happen.
placeholder: Describe the solution you want...

- type: textarea
id: alternative-solutions
validations:
required: false
attributes:
label: Describe alternatives you've considered
description: Mention any alternative solutions or features you've considered.
placeholder: Describe alternative solutions...

- type: textarea
id: additional-context
validations:
required: false
attributes:
label: Additional context
description: Provide any extra context or screenshots related to the feature request.
placeholder: Add any relevant context or details here...

- type: checkboxes
attributes:
label: "Required"
description: "Please confirm:"
options:
- label: "I have checked past issues to see if this feature has already been requested."
required: true
30 changes: 30 additions & 0 deletions .github/ISSUE_TEMPLATE/question.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
---
name: Question
description: Ask a question about this project.
title: "[QUESTION]: "
labels:
- question
body:
- type: textarea
id: question
validations:
required: true
attributes:
label: Question
description: Briefly describe your question.
placeholder: Enter your question here...
- type: textarea
id: additional-context
validations:
required: false
attributes:
label: Additional Context
description: Add any extra context or details about your question here.
placeholder: Add any additional context or details here...
- type: checkboxes
attributes:
label: "Required"
description: "Please confirm:"
options:
- label: "I have checked past issues to see if this question has already answered."
required: true
41 changes: 41 additions & 0 deletions .github/ISSUE_TEMPLATE/refactor.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
---
name: Refactor
description: Propose refactoring something.
title: "[REFACTOR]: "
labels:
- refactor
body:
- type: textarea
id: what-to-refactor
validations:
required: true
attributes:
label: What to refactor
description: Describe briefly what to refactor.
placeholder: Describe what needs to be refactored...

- type: textarea
id: why-refactor
validations:
required: true
attributes:
label: Why refactor it
description: Explain the rationale behind this refactoring.
placeholder: Explain the reason for the refactoring...

- type: textarea
id: how-to-refactor
validations:
required: true
attributes:
label: How to refactor it
description: Outline the steps of the proposed approach for the refactor.
placeholder: Outline the steps for refactoring...

- type: checkboxes
attributes:
label: "Required"
description: "Please confirm:"
options:
- label: "I have checked past issues to ensure that this isn't a duplicate."
required: true
40 changes: 0 additions & 40 deletions frontend/.github/ISSUE_TEMPLATE/bug_report.md

This file was deleted.

19 changes: 0 additions & 19 deletions frontend/.github/ISSUE_TEMPLATE/feature_request.md

This file was deleted.

0 comments on commit ea69897

Please sign in to comment.