improve issue templates

This commit is contained in:
Kevin Papst
2022-10-18 23:42:16 +02:00
parent 1e1b9a6919
commit 662259468d
3 changed files with 121 additions and 45 deletions

View File

@@ -1,27 +1,74 @@
---
name: Bug report name: Bug report
about: Found a problem? Create a report to help us improve Kimai description: Create a report to help us improve Kimai
title: ''
labels: bug labels: bug
assignees: '' body:
- type: markdown
--- attributes:
value: |
**Describe the bug** Thank you for reporting an issue on Kimai! This form will guide you to create a useful issue report.
A clear and concise description of what the bug is. - type: textarea
id: what-happened
**To Reproduce** attributes:
1. Go to '...' label: Describe the issue
2. Click on '....' description: A clear and concise description of the problem you are facing.
3. See error placeholder: Tell us what you see!
validations:
**Logfile** required: true
``` - type: checkboxes
Add the last lines from your logfile at "var/log/prod.log" or "Doctor > Logs", around the time when the problem happened. id: tried
``` attributes:
label: I already tried
**Additional context** description: If you didnt try already, try to search the documentation and existing issues what you wrote above.
- Kimai version: ?.? options:
- PHP version: ?.? - label: I've read and searched [the documentation](https://www.kimai.org/documentation/).
- Device: [Ubuntu Laptop 16 inch, Windows Desktop 27 inch, iPhone 6s] required: true
- Browser [e.g. Firefox 81, Chrome 85, Safari 14] - label: I've searched for similar issues in this repository.
required: true
- label: I've searched for similar issues in [the discussions](https://github.com/kevinpapst/kimai2/discussions).
required: true
- type: textarea
id: reproducer
attributes:
label: Steps to reproduce the behavior
value: |
1. Go to '...'
2. Scroll down to '...'
3. Click on '...'
4. See error
- type: textarea
id: expected
attributes:
label: Expected behavior
description: A clear and concise description of what you expected to happen.
- type: textarea
id: screenshots
attributes:
label: Screenshots
description: If applicable, add screenshots to better explain your problem.
- type: dropdown
id: installation
attributes:
label: How do you run Kimai?
options:
- kimai.cloud service
- Self-Hosted
- Synology
- Other
validations:
required: true
- type: textarea
id: logs
attributes:
label: Logfile
description: >
Please paste the last lines from your logfile at "var/log/prod.log" or "Doctor > Logs", around the time when the problem happened.
- type: textarea
id: additional
attributes:
label: Additional context
description: Add any other context about the problem here.
value: |
Kimai version: ?.?
PHP version: ?.?
Device: [Ubuntu Laptop 16 inch, Windows Desktop 27 inch, iPhone 6s]
Browser [e.g. Firefox 81, Chrome 85, Safari 14]

View File

@@ -1,5 +1,14 @@
blank_issues_enabled: false blank_issues_enabled: false
contact_links: contact_links:
- name: "Support / Questions / Discussions" - name: Read our documentation
url: https://www.kimai.org/documentation/
about: Save your time! There is an instant solution for many issues in the documentation.
- name: Docker image issue tracker
url: https://github.com/tobybatch/kimai2/issues
about: For issues specific for Kimai Docker deployment
- name: Ask a Question
url: https://github.com/kevinpapst/kimai2/discussions url: https://github.com/kevinpapst/kimai2/discussions
about: "This forum is for support questions: eg. if you need help with your Kimai installation, want to know how to use a Kimai feature or wonder where to start creating a new Kimai plugin." about: Want to discuss something with a community? Do it in discussions!
- name: Get Professional support
url: https://www.kimai.org/store/custom-plugins.html
about: As a customer, you will always receive fast and helpful replies from the developer.

View File

@@ -1,20 +1,40 @@
---
name: Feature request name: Feature request
about: Suggest an idea to make Kimai better description: Suggest an idea to make Kimai better
title: ''
labels: feature request labels: feature request
assignees: '' body:
- type: markdown
--- attributes:
value: |
**Is your feature request related to a problem? Please describe.** Thank you for reporting an issue on Kimai! This form will guide you to create a useful issue report.
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] - type: textarea
id: describe
**Describe the solution you'd like** attributes:
A clear and concise description of what you want to happen. label: Describe the problem
description: >
**Describe alternatives you've considered** Is your feature request related to a problem? If so, please provide
A clear and concise description of any alternative solutions or features you've considered. a clear and concise description of what the issue is.
Ex. I'm always frustrated when [...]
**Screenshot** validations:
Add a mockup / screenshot of your idea here. required: true
- type: textarea
id: solution
attributes:
label: Describe the solution you'd like
description: A clear and concise description of what the new feature should do.
validations:
required: true
- type: textarea
id: alternatives
attributes:
label: Describe alternatives you've considered
description: A clear and concise description of any alternative solutions or features you've considered.
- type: textarea
id: screenshots
attributes:
label: Screenshots
description: If applicable, add screenshots to better explain your problem.
- type: textarea
id: additional
attributes:
label: Additional context
description: Add any other context about the problem here.