Improve bug report and feature request templates

This commit is contained in:
sakkamade 2021-08-14 22:57:34 +00:00
parent be051000b5
commit 93226055c8
5 changed files with 66 additions and 45 deletions

View File

@ -1,35 +0,0 @@
---
name: Bug report
about: Create a report to help us improve
title: '[BUG]: '
labels: Type-Defect
assignees: martinrotter
---
<!---
Dear RSS Guard contributor, please RESPECT this template. Also, you might be
interested in reading this: http://www.chiark.greenend.org.uk/~sgtatham/bugs.html
Also, ALWAYS, ALWAYS, ALWAYS attach DEBUG LOG to your bug report!!!
See here how to generate it:
https://github.com/martinrotter/rssguard/blob/master/resources/docs/Documentation.md#generating-debug-log-file
-->
#### Brief description of the issue.
<!--- Write your description here. Remove this line, pls. -->
#### How to reproduce the bug?
1.
2.
3.
#### What was the expected result?
<!--- Write expected results of above reproduction steps here. Remove this line, pls. -->
#### What actually happened?
<!--- Write the actual result here. Remove this line, pls. -->
#### Other information
<!--- Write any other supplementary information here. Remove this line, pls. -->
* OS:
* RSS Guard version:

53
.github/ISSUE_TEMPLATE/bug_report.yml vendored Normal file
View File

@ -0,0 +1,53 @@
name: Bug Report
description: Create a report to help us improve
title: '[BUG]: '
labels: Type-Defect
assignees: martinrotter
body:
- type: markdown
attributes:
value: |
Dear RSS Guard contributor, please RESPECT this template. You might be interested in reading [www.chiark.greenend.org.uk](http://www.chiark.greenend.org.uk/~sgtatham/bugs.html).
Also, ALWAYS, ALWAYS, ALWAYS attach DEBUG LOG to your bug report!!!
How to generate it see [here](https://github.com/martinrotter/rssguard/blob/master/resources/docs/Documentation.md#command-line-interface).
- type: textarea
attributes:
label: Brief description of the issue
description: Write your description here.
validations:
required: true
- type: textarea
attributes:
label: How to reproduce the bug?
placeholder: |
1. (First Step)
2. (Second Step)
3. (etc.)
validations:
required: true
- type: textarea
attributes:
label: What was the expected result?
description: Write expected results of above reproduction steps here.
validations:
required: true
- type: textarea
attributes:
label: What actually happened?
description: Write the actual result here.
validations:
required: true
- type: textarea
attributes:
label: Other information
description: Write any other supplementary information here.
validations:
required: false
- type: textarea
attributes:
label: Operating system and version
value: |
* OS:
* RSS Guard version:
validations:
required: true

1
.github/ISSUE_TEMPLATE/config.yml vendored Normal file
View File

@ -0,0 +1 @@
blank_issues_enabled: false

View File

@ -1,10 +0,0 @@
---
name: Feature request
about: Suggest an idea for this project
title: '[FR]: '
labels: Type-Enhancement
assignees: martinrotter
---
#### Brief description of the feature request.
<!--- Write your description here. Remove this line, pls. -->

View File

@ -0,0 +1,12 @@
name: Feature request
description: Suggest an idea for this project
title: '[FR]: '
labels: Type-Enhancement
assignees: martinrotter
body:
- type: textarea
attributes:
label: Brief description of the feature request
description: Write your description here.
validations:
required: true