Part of #232 - add issue-template for bug, feature-request and also basic pr-template

This commit is contained in:
Sebastian Sellmeier 2021-10-11 14:49:33 +02:00
parent 806866de57
commit c625f8b8a1
No known key found for this signature in database
GPG key ID: 51E2BE0CCC826F98
3 changed files with 112 additions and 0 deletions

70
.github/ISSUE_TEMPLATE/bug.yml vendored Normal file
View file

@ -0,0 +1,70 @@
name: Bug
description: File a bug/issue
labels: ["bug"]
body:
- type: markdown
attributes:
value: Thank you for taking the time to file a bug report. To address this bug as fast as possible, we need some information.
- type: checkboxes
attributes:
label: Is there an existing issue for this?
description: Please search to see if an issue already exists for the bug you encountered.
options:
- label: I have searched the existing issues
required: true
- type: input
id: os
attributes:
label: Operating system
description: "Which operating system do you use? Please provide the version as well."
placeholder: "Ubuntu 20.04.3 LTS"
validations:
required: true
- type: dropdown
id: installation
attributes:
label: Installation method
description: How did you install Betterlockscreen?
options:
- Package Manager (from OS)
- Install-Script
- Manual (please specify in the description!)
validations:
required: true
- type: textarea
id: betterlockscreen
attributes:
label: Betterlockscreen & Dependency-Versions
description: Please provide the full output of "betterlockscreen -v". For previous versions which do not have this command, please provide the used version(s).
render: shell
value: |
- Betterlockscreen:
- i3lock-color:
- ImageMagick:
- dunst (if used):
- feh (if used):
validations:
required: true
- type: textarea
id: bug-description
attributes:
label: Bug description
description: What happened?
validations:
required: true
- type: textarea
id: steps
attributes:
label: Steps to reproduce
description: Which steps do we need to take to reproduce this error?
placeholder: |
1. In this environment...
2. With this config...
3. Run '...'
4. See error...
- type: textarea
id: logs
attributes:
label: Relevant log output
description: Please provide relevant log output (e.g. from journalctl). No need for backticks here.
render: shell

View file

@ -0,0 +1,28 @@
name: Feature Request
description: You have an idea for extending?
labels: ["feature-request"]
body:
- type: markdown
attributes:
value: Thank you for taking the time to share your idea's with us!
- type: textarea
id: feature-request
attributes:
label: Feature Request
description: Whats your idea?
validations:
required: true
- type: textarea
id: steps
attributes:
label: Implementation
description: Can you give us your vision, how you would implement it? (if possible)
- type: dropdown
id: contribute
attributes:
label: Have you planned working on this feature?
options:
- "Yes"
- "No"
validations:
required: true

14
.github/pull_request_template.md vendored Normal file
View file

@ -0,0 +1,14 @@
# Description
Please include a summary of the changes and if applicable which issue it fixes. Please also include relevant motivation and context. If there are changes to the dependencies/min. version-constraints please mention them.
Fixes # (issue)
# How Has This Been Tested?
Please describe the tests that you ran to verify your changes.
# Checklist:
- [ ] I have performed a self-review of my own code/checked that ShellCheck succeeds
- [ ] I have made corresponding changes to the documentation (if applicable)