Skip to content

Commit

Permalink
Issue template improvements
Browse files Browse the repository at this point in the history
  • Loading branch information
andyone committed Oct 9, 2024
1 parent 5cbb259 commit b1a3497
Show file tree
Hide file tree
Showing 5 changed files with 147 additions and 51 deletions.
51 changes: 0 additions & 51 deletions .github/ISSUE_TEMPLATE.md

This file was deleted.

64 changes: 64 additions & 0 deletions .github/ISSUE_TEMPLATE/bug.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
name: ❗ Bug Report
description: File a bug report
title: "[Bug]: "
labels: ["issue • bug"]
assignees:
- andyone

body:
- type: markdown
attributes:
value: |
> [!IMPORTANT]
> Before you open an issue, search GitHub Issues for a similar bug reports. If so, please add a 👍 reaction to the existing issue.
- type: textarea
attributes:
label: Verbose application info
description: Output of `yo -vv` command
render: shell
validations:
required: true

- type: dropdown
id: version
attributes:
label: Install tools
description: How did you install this application
options:
- From Sources
- RPM Package
- Prebuilt Binary
default: 0
validations:
required: true

- type: textarea
attributes:
label: Steps to reproduce
description: Short guide on how to reproduce this problem on our site
placeholder: |
1. [First Step]
2. [Second Step]
3. [and so on...]
validations:
required: true

- type: textarea
attributes:
label: Expected behavior
description: What you expected to happen
validations:
required: true

- type: textarea
attributes:
label: Actual behavior
description: What actually happened
validations:
required: true

- type: textarea
attributes:
label: Additional info
description: Include gist of relevant config, logs, etc.
14 changes: 14 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
blank_issues_enabled: false

contact_links:
- name: Security Policies and Procedures
url: https://github.com/essentialkaos/.github/blob/master/SECURITY.md
about: Security procedures and general policies for all ESSENTIAL KAOS projects.

- name: Contributing Guidelines
url: https://github.com/essentialkaos/contributing-guidelines/blob/master/CONTRIBUTING.md
about: Contributing Guidelines for all ESSENTIAL KAOS projects

- name: Go Version Support Policy
url: https://github.com/essentialkaos/.github/blob/master/GO-VERSION-SUPPORT.md
about: Information about supported Go versions
26 changes: 26 additions & 0 deletions .github/ISSUE_TEMPLATE/question.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
name: ❓ Question
description: Question about application, configuration or code
title: "[Question]: "
labels: ["issue • question"]
assignees:
- andyone

body:
- type: markdown
attributes:
value: |
> [!IMPORTANT]
> Before you open an issue, search GitHub Issues for a similar question. If so, please add a 👍 reaction to the existing issue.
- type: textarea
attributes:
label: Question
description: Detailed question
validations:
required: true

- type: textarea
attributes:
label: Related version application info
description: Output of `yo -vv` command
render: shell
43 changes: 43 additions & 0 deletions .github/ISSUE_TEMPLATE/suggestion.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
name: ➕ Suggestion
description: Suggest new feature or improvement
title: "[Suggestion]: "
labels: ["issue • suggestion"]
assignees:
- andyone

body:
- type: markdown
attributes:
value: |
> [!IMPORTANT]
> Before you open an issue, search GitHub Issues for a similar feature requests. If so, please add a 👍 reaction to the existing issue.
>
> Opening a feature request kicks off a discussion. Requests may be closed if we're not actively planning to work on them.
- type: textarea
attributes:
label: Proposal
description: Description of the feature
validations:
required: true

- type: textarea
attributes:
label: Current behavior
description: What currently happens
validations:
required: true

- type: textarea
attributes:
label: Desired behavior
description: What you would like to happen
validations:
required: true

- type: textarea
attributes:
label: Use case
description: Why is this important (helps with prioritizing requests)
validations:
required: true

0 comments on commit b1a3497

Please sign in to comment.