Skip to content

We need a new issue template for reporting bug related issues #106

@Vizonex

Description

@Vizonex

Important

This has taken me a while to write (over an hour) and definitely not how I wanted to spend my weekend so keep in mind with me that I am doing my best within my own mental capacity to explain this problem.

I'm having trouble coming up with a proper issue template from a .yaml file extension due to the vagueness and wording of the documentation but here is some examples of what I am expecting to see more of in the future:

The Rules going forward should be simple practice and common sense for anybody to understand

We need a template that Acknowledges these important key rules

  • Disallowing AI/LLM Generated issues or code and closing/terminating these issues if or when found along with labeling a tag titled AI Generated or AI
  • Acknowledge that duplicate issues will be redirected and promptly discarded.
  • Acknowledge that vague reproducers may result in not being able to do anything or even having the issue being closed or terminated.
  • Acknowledge that reproducers should be text and not partial code snippets or screenshots and that no closed source code for reproducers should be allowed period
  • Acknowledge that if a problem or bug is not related to winloop that it will be labeled as being an external-library's-fault and possibly may be reviewed on weather or not to close or redirect the issue to that external library's repo.
  • Encourage Users to write a description of the bug being faced although have it be a completely optional thing.

Something like this .yaml configuration is what I'm aiming for but currently I don't understand it.

name: Report Bug with winloop
description: Report an issue with winloop
body:
  - type: markdown
    attributes:
      value: |
        > [!IMPORTANT]
        > Ensure you have agreed to these terms before throwing an issue

  - type: checkboxes
    id: checklist
    attributes:
      label: Checklist
      description: |
        Carefully read and checkmark all the terms and conditions before 
        continuing with reporting the issue
      options:
        - label: I am not a kindergartener and that creating AI generated code or grammar of any sort
            will result in my issue being terminated, promptly closed and labeled as **AI**
          required: true
        - label: If there was already an issue about this that hasn't been closed at all
            your issue will be treated and duplicate and closed
          required: true
        - label: If I do not have a code snippet or can't reproduce the bug to the issue I'm 
            experiencing to best of my own abilities then the issue will be ignored.
          required: true
        - label: If something is caused by a dependency that is unrelated to winloop 
            my issue will be labeled under **external library's fault** and that I will be redirected
            to throwing the issue with the external library's issue page
          required: true
        - lablel: If my code is incomplete it will be marked as **reproducer vauge** and that I will need
            to go back and redo my reproducable bug.
          required: true

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationenhancementNew feature or requestgithub_actionsPull requests that update GitHub Actions codehelp wantedExtra attention is needed

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions