From fd2d2d69cf92c109e6aee1645d28ee40566a571b Mon Sep 17 00:00:00 2001 From: yfprojects <62463991+real-yfprojects@users.noreply.github.com> Date: Sat, 16 Apr 2022 09:26:49 +0000 Subject: [PATCH 1/6] Update bug_report.md --- .github/ISSUE_TEMPLATE/bug_report.md | 35 +++++++++++++++++++++------- 1 file changed, 26 insertions(+), 9 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index a9caf890..7b2d69f9 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -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** + + +I _was_/_wasn't_ able to reproduce the issue. + + + +#### 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. + -**Additional context** -If appropriate include logs. Can be found in Main Window > Misc Tab > Log. +#### Logs + + + +``` +*paste logs here* +``` From ff0b8883f8eac1757485eda0389469062dcf2279 Mon Sep 17 00:00:00 2001 From: yfprojects <62463991+real-yfprojects@users.noreply.github.com> Date: Sat, 16 Apr 2022 09:11:21 +0000 Subject: [PATCH 2/6] Create config.yml Link docs, discussions and FAQ on the issue page. * .github/ISSUE_TEMPLATE/config.yml --- .github/ISSUE_TEMPLATE/config.yml | 13 +++++++++++++ 1 file changed, 13 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/config.yml diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 00000000..05128848 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -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. From 52b1e65c92ab28d6b315cedfa351b00bdcc54462 Mon Sep 17 00:00:00 2001 From: yfprojects <62463991+real-yfprojects@users.noreply.github.com> Date: Sat, 16 Apr 2022 10:58:14 +0000 Subject: [PATCH 3/6] Create bug_form.yaml --- .github/ISSUE_TEMPLATE/bug_form.yaml | 89 ++++++++++++++++++++++++++++ 1 file changed, 89 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_form.yaml diff --git a/.github/ISSUE_TEMPLATE/bug_form.yaml b/.github/ISSUE_TEMPLATE/bug_form.yaml new file mode 100644 index 00000000..f30d9117 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_form.yaml @@ -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: , + 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 From 3b40ce8e01ed49c14dc2b5c0ad9596242ff3a1c1 Mon Sep 17 00:00:00 2001 From: yfprojects <62463991+real-yfprojects@users.noreply.github.com> Date: Sat, 16 Apr 2022 11:34:59 +0000 Subject: [PATCH 4/6] Create feature_request.md * .github/ISSUE_TEMPLATE/feature_request.md --- .github/ISSUE_TEMPLATE/feature_request.md | 31 +++++++++++++++++++++++ 1 file changed, 31 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 00000000..86687a59 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,31 @@ +--- +name: Feature Request +about: Suggest an idea for this project. +title: 'FR: ' +labels: 'type:enhancement' +assignees: '' + +--- + +#### The problem + + + +#### Requested Solution + + +#### Alternatives + + +#### Additional context + From be194d92d9be1856706772fffbd75e98069dddc2 Mon Sep 17 00:00:00 2001 From: real-yfprojects Date: Sun, 18 Sep 2022 08:04:17 +0200 Subject: [PATCH 5/6] Add CONTRIBUTING file. * .github/CONTRIBUTING.md --- .github/CONTRIBUTING.md | 4 ++++ 1 file changed, 4 insertions(+) create mode 100644 .github/CONTRIBUTING.md diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md new file mode 100644 index 00000000..0a089b10 --- /dev/null +++ b/.github/CONTRIBUTING.md @@ -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. From 17cf8102f004b277ff4c95fa0f04fb398e2046da Mon Sep 17 00:00:00 2001 From: real-yfprojects Date: Sun, 18 Sep 2022 08:21:50 +0200 Subject: [PATCH 6/6] Add pull request template. * .github/PULL_REQUEST_TEMPLATE/pull_request_template.md --- .../pull_request_template.md | 43 +++++++++++++++++++ 1 file changed, 43 insertions(+) create mode 100644 .github/PULL_REQUEST_TEMPLATE/pull_request_template.md diff --git a/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md new file mode 100644 index 00000000..65529064 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md @@ -0,0 +1,43 @@ + + +### Description + + +### Related Issue + + + + + +### Motivation and Context + + +### How Has This Been Tested? + + + + +### Screenshots (if appropriate): + +### Types of changes + +- [ ] 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: + + +- [ ] 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.* + +