Skip to content

Commit

Permalink
Add templates for bug reports and feature requests, and a link to the…
Browse files Browse the repository at this point in the history
… mailing list for support queries
  • Loading branch information
DrHyde committed Dec 21, 2021
1 parent c6bc185 commit 5ef827f
Show file tree
Hide file tree
Showing 3 changed files with 104 additions and 0 deletions.
62 changes: 62 additions & 0 deletions .github/ISSUE_TEMPLATE/1_report_bug.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
name: Report a bug
description: Report a bug in rsnapshot
labels: [bug]
body:
- type: checkboxes
id: checklist
attributes:
label: Checklist
description: Carefully read and work through this check list
options:
- label: I'm reporting a bug
required: true
- label: I've searched the [bugtracker](https://github.com/rsnapshot/rsnapshot/issues) for similar issues, including closed ones.
required: true
- type: textarea
id: what-i-did
attributes:
label: What did you do?
description: What steps should we follow to reproduce the problem?
validations:
required: true
- type: textarea
id: what-happened
attributes:
label: What happened?
description: Describe exactly what happened
validations:
required: true
- type: textarea
id: what-i-expected
attributes:
label: What did you expect to happen
description: What do you think _should have_ happened?
validations:
required: true
- type: textarea
id: configuration
attributes:
label: My configuration
description: "Copy n paste your config here. This shell snippet may be useful for stripping blank lines and comments: `sed 's/ *#.*//' /path/to/rsnapshot.conf | grep .`"
validations:
required: true
- type: textarea
attributes:
label: Environment
description: |
examples:
- **server OS**: FreeBSD 12
- **snapshot_root filesystem**: ZFS
value: |
OS:
Filesystem:
render: markdown
validations:
required: false
- type: textarea
id: other-info
attributes:
label: Other information
description: Any other useful information?
placeholder: For example a snippet from your logs

37 changes: 37 additions & 0 deletions .github/ISSUE_TEMPLATE/2_feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
name: Feature request
description: Request a feature to be added or changed in rsnapshot
labels: [feature]
body:
- type: checkboxes
id: checklist
attributes:
label: Checklist
description: Carefully read and work through this check list
options:
- label: I'm asking for a feature to be changed or added
required: true
- label: I've searched the [bugtracker](https://github.com/rsnapshot/rsnapshot/issues) for similar issues, including closed ones.
required: true
- label: I realise that rsnapshot is stable software and most feature requests will be rejected
required: true
- type: textarea
id: what-i-want
attributes:
label: My suggestion is ...
description: What would you like to see changed or added?
validations:
required: true
- type: textarea
id: why-i-want-it
attributes:
label: Why I want it
description: Why would this be useful?
validations:
required: true
- type: textarea
id: why-in-rsnapshot
attributes:
label: Why should this be in rsnapshot and not implemented using some external tool?
description: What other approaches have you considered and why have you rejected them?
validations:
required: true
5 changes: 5 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
blank_issues_enabled: false
contact_links:
- name: Get support on the mailing list
url: https://sourceforge.net/p/rsnapshot/mailman/rsnapshot-discuss/
about: Join the mailing list for community support

0 comments on commit 5ef827f

Please sign in to comment.