1
Fork 0
mirror of https://github.com/RGBCube/GitHubWrapper synced 2025-05-30 20:48:12 +00:00

Add Issue Templates

- Added Bug Report Template
- Added Feature Request Template
- Added Issue Menu Config
This commit is contained in:
RGBCube 2022-06-21 18:41:25 +03:00
parent f38f253de0
commit ad784f87cb
3 changed files with 107 additions and 0 deletions

57
.github/ISSUE_TEMPLATE/bug_report.yml vendored Normal file
View file

@ -0,0 +1,57 @@
name: Bug Report
description: Report broken or incorrect behaviour
labels:
- bug
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out a bug.
If you want real-time support, consider joining our [Discord server](https://discord.gg/pTJfS4TkWe) instead.
Please note that this form is for bugs only!
- type: input
attributes:
label: Summary
description: A simple summary of your bug report.
validations:
required: true
- type: textarea
attributes:
label: Reproduction Steps
description: What you do to make it happen?
validations:
required: true
- type: textarea
attributes:
label: Minimal Reproducible Code
description: A short snippet of code that showcases the bug.
render: Python
- type: textarea
attributes:
label: Expected Results
description: What did you expect to happen?
validations:
required: true
- type: textarea
attributes:
label: Actual Results
description: What actually happened?
validations:
required: true
- type: checkboxes
attributes:
label: Checklist
description: |
Let's make sure you've properly done due diligence when reporting this issue!
options:
- label: I have searched the open issues for duplicates.
required: true
- label: I have shown the entire traceback, if possible.
required: true
- label: I have removed my token from display, if visible.
required: true
- type: textarea
attributes:
label: Additional Context
description: If there is anything else to say, please do so here.

4
.github/ISSUE_TEMPLATE/config.yml vendored Normal file
View file

@ -0,0 +1,4 @@
contact_links:
- name: Discord Server
about: Use our official Discord server to ask for help and questions.
url: https://discord.gg/pTJfS4TkWe

View file

@ -0,0 +1,46 @@
name: Feature Request
description: Suggest a feature for this library
labels:
- enhancement
body:
- type: input
attributes:
label: Summary
description: A short summary of what your feature request is.
validations:
required: true
- type: dropdown
attributes:
multiple: false
label: What is the feature request for?
options:
- The library
- The documentation
validations:
required: true
- type: textarea
attributes:
label: The Problem
description: |
What problem is your feature trying to solve?
What becomes easier or possible when this feature is implemented?
validations:
required: true
- type: textarea
attributes:
label: The Ideal Solution
description: |
What is your ideal solution to the problem?
What would you like this feature to do?
validations:
required: true
- type: textarea
attributes:
label: The Current Solution
description: What is the current solution to the problem, if any?
validations:
required: false
- type: textarea
attributes:
label: Additional Context
description: If there is anything else to say, please do so here.