mirror
/
vorta
mirror of https://github.com/borgbase/vorta
1
0
Fork 0
Code Issues Releases Wiki Activity

Enhance community docs and bug reporting. By @real-yfprojects (#1419)

This commit is contained in:
Manu 2022-09-18 21:06:40 +02:00 committed by GitHub
parent 62ba92a0ed 17cf8102f0
commit 496acfde99
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
6 changed files with 206 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
.github/CONTRIBUTING.md vendored Normal file
View File

@ -0,0 +1,4 @@
# Connect and Contribute
- To discuss everything around using, improving, packaging and translating Vorta, join the [discussion on Github](https://github.com/borgbase/vorta/discussions).
- Report bugs by opening a new [Github issue](https://github.com/borgbase/vorta/issues/new/choose).
- Want to contribute to Vorta? Great! See our [contributor guide](https://vorta.borgbase.com/contributing/) on how to help out with coding, translation and packaging.

89
.github/ISSUE_TEMPLATE/bug_form.yaml vendored Normal file
View File

@ -0,0 +1,89 @@
name: "Bug Report Form"
description: "Report a bug or a similiar issue."
body:
- type: markdown
attributes:
value: |
Thank you for reporting an issue. Please fill out the below template with as much detail as possible. Incomplete bug reports are likely to be closed without comment.
If you want to suggest a feature use the `Feature Request` template instead.
If you have any other question, head to
our [Discussions](https://github.com/borgbase/vorta/discussions).
- type: textarea
id: description
attributes:
label: Description
description: |
Please decribe your issue and its context in a clear and concise way. Please try to reproduce the issue and provide the steps to reproduce it.
Wrap error messages in triple backticks.
placeholder: |
I encountered a bug.
```Error message```
Steps to reproduce:
1.
2.
3.
validations:
required: true
- type: checkboxes
id: reproducible
attributes:
label: Reproduction
description: Please try to reproduce the issue with the steps you provided and capture the logs of this try for the form input below.
options:
- label: I tried to reproduce the issue.
required: true
- label: I was able to reproduce the issue.
- type: input
id: os
attributes:
label: OS
description: Operating system (and desktop environment)
placeholder: <os> <version>, <desktop> <version>
validations:
required: true
- type: input
id: version
attributes:
label: Version of Vorta
description: Vorta and Borg versions can be found in Main Window > Misc Tab.
validations:
required: true
- type: dropdown
id: installation
attributes:
label: What did you install Vorta with?
options:
- Homebrew
- Binary
- Distribution package
- Flatpak
- Pip
- Other
validations:
required: true
- type: input
id: borg
attributes:
label: Version of Borg
description: Vorta and Borg versions can be found in Main Window > Misc Tab.
- type: textarea
id: logs
attributes:
label: Logs
description: |
Logs are very important for most issues. Please paste them down below. *(No need for backticks)*
They can be found in Main Window > Misc Tab > Log.
Logs are more helpful if you include (exactly) the logs that were produced during the steps you described above.
placeholder: paste logs here
render: pytb

35
.github/ISSUE_TEMPLATE/bug_report.md vendored
View File

@ -1,6 +1,6 @@
---
name: Bug report
about: Create a report to help us improve
name: Bug Report
about: Report a bug or a similiar issue - the classic way
title: ''
labels: ''
assignees: ''
@ -15,22 +15,39 @@ If you want to suggest a feature or have any other question, please use our
[Discussions](https://github.com/borgbase/vorta/discussions) instead.
-->
**Describe the bug**
A clear and concise description of what the bug is.
#### Description
**To Reproduce**
<!-- Description
Please decribe your issue and its context in a clear and concise way.
Please try to reproduce the issue and provide the steps to reproduce it.
-->
I _was_/_wasn't_ able to reproduce the issue.
<!-- E.g.
Steps to reproduce the behavior:
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error
-->
#### Environment
**Environment (please complete the following information):**
- OS:
- Vorta version:
- Installed from:
- Borg version:
Vorta and Borg versions can be found in Main Window > Misc Tab.
<!-- Vorta and Borg versions can be found in Main Window > Misc Tab. -->
**Additional context**
If appropriate include logs. Can be found in Main Window > Misc Tab > Log.
#### Logs
<!-- Logs are very important for most issues. Please paste them down below.
They can be found in Main Window > Misc Tab > Log.
Logs are more helpful if you include (exactly) the logs that were produced during the steps you described above.
-->
```
*paste logs here*
```

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

@ -0,0 +1,13 @@
contact_links:
- name: Documentation
url: https://vorta.borgbase.com/
about: Documentation on installing, using and contributing to Vorta.
- name: Support
url: https://github.com/borgbase/vorta/discussions/categories/faq
about: Please ask for support in the Discussions FAQ.
- name: Discussions
url: https://github.com/borgbase/vorta/discussions
about: Discuss everything here.

31
.github/ISSUE_TEMPLATE/feature_request.md vendored Normal file
View File

@ -0,0 +1,31 @@
---
name: Feature Request
about: Suggest an idea for this project.
title: 'FR: '
labels: 'type:enhancement'
assignees: ''
---
#### The problem
<!--
Is your feature request related to a problem?
Please provide a clear and concise description of what the problem is.
Ex. I'm always frustrated when [...]
-->
#### Requested Solution
<!--
A clear and concise description of what you want to happen.
-->
#### Alternatives
<!--
A clear and concise description of any alternative solutions or features you've considered.
-->
#### Additional context
<!--
Add any other context or screenshots about the feature request here.
-->

43
.github/PULL_REQUEST_TEMPLATE/pull_request_template.md vendored Normal file
View File

@ -0,0 +1,43 @@
<!--- Provide a general summary of your changes in the Title above -->
### Description
<!--- Describe your changes in detail -->
### Related Issue
<!--- This project only accepts pull requests related to open issues -->
<!--- If suggesting a new feature or change, please discuss it in an issue first -->
<!--- If fixing a bug, there should be an issue describing it with steps to reproduce -->
<!--- Please link to the issue here: -->
### Motivation and Context
<!--- Why is this change required? What problem does it solve? -->
### How Has This Been Tested?
<!--- Please describe in detail how you tested your changes. -->
<!--- Include details of your testing environment, and the tests you ran to -->
<!--- see how your change affects other areas of the code, etc. -->
### Screenshots (if appropriate):
### Types of changes
<!--- What types of changes does your code introduce? Put an `x` in all the boxes that apply: -->
- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing functionality to change)
### Checklist:
<!--- Go over all the following points, and put an `x` in all the boxes that apply. -->
<!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! -->
- [ ] My code follows the code style of this project.
- [ ] My change requires a change to the documentation.
- [ ] I have updated the documentation accordingly.
- [ ] I have read the [CONTRIBUTING](https://vorta.borgbase.com/contributing/) guide.
- [ ] I have added tests to cover my changes.
- [ ] All new and existing tests passed.
*I provide my contribution under the terms of the [license](./../../LICENSE.txt) of this repository and I affirm the Developer Certificate of Origin.*
<!--
This template is sourced from the awesome https://github.com/TalAter/open-source-templates
-->