Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adds Issue templates for bug report and feature request #567

Open
wants to merge 7 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 46 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

name: Bug report
description: Create a report to help us improve (search for duplicates first)
labels: bug
body:
 - type: textarea
   attributes:
    label: Issue description
    description: Explain clearly and unambiguously what went wrong
    placeholder: |
      Tell us here about the bug/problem
   validations:
    required: true
 - type: textarea
   attributes:
    label: How to reproduce this issue?
    description: Try to explain what you did for the bug to occur. A good explanation of steps to reproduce helps us locate the bug faster. If applicable, add screenshots to help explain your problem.
    placeholder: |
      Step 1: ...
      Step 2: ...
      ...
   validations:
     required: true  # Changed from `required: false` to `required: true`
 - type: textarea
   attributes:
    label: Details
    description: To understand the issue, we need some details of your setup & system
    placeholder: |
      Version: xy / zg ...
   validations:
     required: true

Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
name: Bug report
description: Create a report to help us improve (search for duplicates first)
labels: bug
body:
- type: textarea
attributes:
label: Issue description
description: Explain clearly and unambiguously what went wrong
placeholder: |
Tell us here about the bug/problem
validations:
required: true
- type: textarea
attributes:
label: How to reproduce this issue?
description: Try to explain what you did for the bug to occur. A good explanation of steps to reproduce helps us locate the bug faster. If applicable, add screenshots to help explain your problem.
placeholder: |
Step 1: ...
Step 2: ...
...
validations:
required: false
- type: textarea
attributes:
label: Details
description: To understand the issue, we need some details of your setup & system
placeholder: |
Version: xy / zg ...]
validations:
required: true
Comment on lines +23 to +30
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This makes no sense in the context of this repo.
The system is github. For all of us.

- type: textarea
attributes:
label: Logs
description:
placeholder: |
[example_log.txt / example_log.md ...]
validations:
required: false
Comment on lines +31 to +38
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Makes no sense.

- type: checkboxes
attributes:
label: Issue tracker rule checks (please read carefully)
options:
- label: "I have checked that my problem <a href='https://github.com/Schweinepriester/github-profile-achievements/issues' target='_blank'>is not already reported</a>"
required: true
- label: "I have checked that my problem is not already fixed"
required: true
5 changes: 5 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

contact_links:
  - name: "GitHub"
    url: https://github.com/Schweinepriester
    about: My GitHub Page
  - name: "LinkedIn"
    url: https://www.linkedin.com/in/schweinepriester
    about: My LinkedIn Profile

Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
blank_issues_enabled: false
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why?

contact_links:
- name: "GitHub"
url: https://github.com/Schweinepriester
about: My GitHub Page
28 changes: 28 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
name: Feature Request
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Feature Requests makes little sense when this repo does not hold software.
This repo is purely documentation.
The term "feature request" doesn't really apply here.

description: Create a report to help us improve (search for duplicates first)
labels: enhancement
body:
- type: textarea
attributes:
label: Feature description
description: Explain clearly
placeholder: |
Tell us here about the feature
validations:
required: true
- type: textarea
attributes:
label: Logs
description: Provide logs
placeholder: |
example_log.txt
validations:
required: false
Comment on lines +13 to +20
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For feature requests? really?

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

description: Create a report to help us improve (search for duplicates first)
labels: enhancement
body:
 - type: textarea
   attributes:
    label: Feature description
    description: Explain clearly
    placeholder: |
     Tell us here about the feature
   validations:
    required: true
 - type: textarea
   attributes:
    label: Logs
    description: Provide logs
    placeholder: |
     example_log.txt
   validations:
    required: false

- type: checkboxes
attributes:
label: Issue tracker rule checks (please read carefully)
options:
- label: "I have checked that this feature <a href='https://github.com/Schweinepriester/github-profile-achievements/issues' target='_blank'>is not already requested.</a>"
required: true
- label: "I have checked that this feature is not already implemented"
required: true