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

Conversation

PSGitHubUser1
Copy link

Modified by me. @PSGitHubUser1

@PSGitHubUser1
Copy link
Author

PSGitHubUser1 commented Jan 12, 2023

Please approve.... @Schweinepriester

Copy link

@Chameleon-Coder Chameleon-Coder left a comment

Choose a reason for hiding this comment

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

I may be just a normal user, but this looks okay. The owner of the repo has some suggestions.
EDIT: clarity

@PSGitHubUser1
Copy link
Author

Really, if yes then accept this pull request.. pls

Copy link

@port19x port19x left a comment

Choose a reason for hiding this comment

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

Seems like you either copy pasted from somewhere or didn't put much thought into this.
I don't know which would be worse tbh.

Comment on lines +23 to +30
- 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
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.

Comment on lines +31 to +38
- type: textarea
attributes:
label: Logs
description:
placeholder: |
[example_log.txt / example_log.md ...]
validations:
required: false
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.

@@ -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?

Comment on lines +13 to +20
- type: textarea
attributes:
label: Logs
description: Provide logs
placeholder: |
example_log.txt
validations:
required: false
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

.github/ISSUE_TEMPLATE/feature_request.yml Outdated Show resolved Hide resolved
@@ -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.

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

Comment on lines +13 to +20
- type: textarea
attributes:
label: Logs
description: Provide logs
placeholder: |
example_log.txt
validations:
required: false

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

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants