From dd441a552a62ca6a98c042d627c72a4141ed657a Mon Sep 17 00:00:00 2001
From: simonsan <14062932+simonsan@users.noreply.github.com>
Date: Sat, 19 Aug 2023 04:20:19 +0200
Subject: [PATCH 01/26] Create bug_report.md template
To make it easier for the users and us to understand what is happening and why, and what the preconditions are.
---
.github/ISSUE_TEMPLATE/bug_report.md | 45 ++++++++++++++++++++++++++++
1 file changed, 45 insertions(+)
create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
new file mode 100644
index 000000000..4648bc56f
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -0,0 +1,45 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ['S-triage', 'C-bug']
+assignees: ''
+
+---
+
+## Describe the bug
+A clear and concise description of what the bug is.
+
+### Code sample
+```text
+A short code snippet that can be used to reproduce the bug. Do NOT paste screenshots of code!
+```
+
+### To reproduce
+Steps to reproduce the behavior, if it's a bug in `rustic_core` or anything code related, please provide a reproducible example.
+
+```
+rustic output here
+```
+
+## Expected behavior
+A clear and concise description of what you expected to happen.
+
+## Versions (please complete the following information)
+
+| | |
+|-|-|
+| Operating System | e.g., Windows 10, MacOS 10.15, Debian 10 |
+| Kernel Version/OS Build |
- *nix: run `uname -a` in the terminal,
- Windows: press `Win + R`, enter `System` and copy `OS Build` from Windows specifications (on Win11)
- MacOS: run `uname -av` in the terminal
|
+| rustic version | output of `rustic --version` |
+| Install type | e.g. build from source (from where?), from binary (e.g. package management system, which one?), other (please elaborate) |
+
+## Additional context
+Add any other context about the problem here.
+
+## Please confirm:
+
+- [ ] I have searched the [discussions](https://github.com/rustic-rs/rustic/discussions) and it wasn't discussed before.
+- [ ] I have searched the [issue list (incl. closed issues](https://github.com/rustic-rs/rustic/issues?q=is%3Aissue) and am not opening a duplicate issue.
+- [ ] I have verified the issue still exists in [`rustic (beta)` (built from the main branch)](https://github.com/rustic-rs/rustic-beta).
+
From 257823bf8deb16239983ac32aee5d85cf2985e91 Mon Sep 17 00:00:00 2001
From: simonsan <14062932+simonsan@users.noreply.github.com>
Date: Sat, 19 Aug 2023 04:46:19 +0200
Subject: [PATCH 02/26] meta(docs): add PR template and authors file
---
.github/ISSUE_TEMPLATE/bug_report.md | 36 ++++++++++++-------
.github/ISSUE_TEMPLATE/feature_request.md | 31 ++++++++++++++++
.../pull_request_template.md | 20 +++++++++++
AUTHORS.md | 24 +++++++++++++
4 files changed, 98 insertions(+), 13 deletions(-)
create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md
create mode 100644 .github/PULL_REQUEST_TEMPLATE/pull_request_template.md
create mode 100644 AUTHORS.md
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
index 4648bc56f..b9aa60e42 100644
--- a/.github/ISSUE_TEMPLATE/bug_report.md
+++ b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -8,38 +8,48 @@ assignees: ''
---
## Describe the bug
+
A clear and concise description of what the bug is.
### Code sample
+
```text
A short code snippet that can be used to reproduce the bug. Do NOT paste screenshots of code!
```
### To reproduce
-Steps to reproduce the behavior, if it's a bug in `rustic_core` or anything code related, please provide a reproducible example.
-```
+Steps to reproduce the behavior, if it's a bug in `rustic_core` or anything code
+related, please provide a reproducible example.
+
+```text
rustic output here
```
## Expected behavior
+
A clear and concise description of what you expected to happen.
## Versions (please complete the following information)
-| | |
-|-|-|
-| Operating System | e.g., Windows 10, MacOS 10.15, Debian 10 |
-| Kernel Version/OS Build | - *nix: run `uname -a` in the terminal,
- Windows: press `Win + R`, enter `System` and copy `OS Build` from Windows specifications (on Win11)
- MacOS: run `uname -av` in the terminal
|
-| rustic version | output of `rustic --version` |
-| Install type | e.g. build from source (from where?), from binary (e.g. package management system, which one?), other (please elaborate) |
+| | |
+| ----------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| Operating System | e.g., Windows 10, MacOS 10.15, Debian 10 |
+| Kernel Version/OS Build | - *nix: run `uname -a` in the terminal,
- Windows: press `Win + R`, enter `System` and copy `OS Build` from Windows specifications (on Win11)
- MacOS: run `uname -av` in the terminal
|
+| rustic version | output of `rustic --version` |
+| Install type | e.g. build from source (from where?), from binary (e.g. package management system, which one?), other (please elaborate) |
## Additional context
-Add any other context about the problem here.
-## Please confirm:
+Add any other context about the problem here.
-- [ ] I have searched the [discussions](https://github.com/rustic-rs/rustic/discussions) and it wasn't discussed before.
-- [ ] I have searched the [issue list (incl. closed issues](https://github.com/rustic-rs/rustic/issues?q=is%3Aissue) and am not opening a duplicate issue.
-- [ ] I have verified the issue still exists in [`rustic (beta)` (built from the main branch)](https://github.com/rustic-rs/rustic-beta).
+## Please confirm
+- [ ] I have searched the
+ [discussions](https://github.com/rustic-rs/rustic/discussions) and it
+ wasn't discussed before.
+- [ ] I have searched the
+ [issue list (incl. closed issues](https://github.com/rustic-rs/rustic/issues?q=is%3Aissue)
+ and am not opening a duplicate issue.
+- [ ] I have verified the issue still exists in
+ [`rustic (beta)` (built from the main branch)](https://github.com/rustic-rs/rustic-beta).
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
new file mode 100644
index 000000000..040ca781a
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -0,0 +1,31 @@
+---
+name: Feature request
+about: "Create a feature requests to let us know what you wish us to improve. Please search for existing issues first. Also see our CONTRIBUTING.md."
+title: ''
+labels: ['S-triage', 'C-enhancement']
+assignees: ''
+---
+
+### Please Describe The Problem To Be Solved
+
+
+
+### (Optional): Suggest A Solution
+
+
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 000000000..b2fe67bba
--- /dev/null
+++ b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md
@@ -0,0 +1,20 @@
+
+
+Here is the issue related to this PR: (Replace this with the corresponding issue number)
+
+
+
+### Checklist
+
+- [ ] I have read the [CONTRIBUTING.md](/CONTRIBUTING.md) document.
+- [ ] I have added tests to cover my changes.
+- [ ] All new and existing tests passed.
+- [ ] I have updated the documentation accordingly.
+- [ ] I have added myself to the [AUTHORS.md](/AUTHORS.md) file.
diff --git a/AUTHORS.md b/AUTHORS.md
new file mode 100644
index 000000000..f68d11252
--- /dev/null
+++ b/AUTHORS.md
@@ -0,0 +1,24 @@
+# `rustic`: Authors & Contributors
+
+Everyone who has contributed to the `rustic` project is listed here. By adding
+your name to this list, you agree to the license terms of this project.
+
+| Name/Alias | Contact (Email or GitHub) | Agreement to License |
+| --------------- | ------------------------- | -------------------- |
+| Alexander Weiss | @aawsome | Yes |
+| simonsan | @simonsan | Yes |
+
+---
+
+To add your name to this list:
+
+1. Fork the repository.
+2. Edit this `AUTHORS.md` file to add your details in the format above.
+3. Create a pull request.
+
+Thank you to all our contributors!
+
+---
+
+For more details on the license, please see
+[Contributors guidelines](./CONTRIBUTING.md).
From ac0de7f8fa8c5b4af46399159cb0bb4f0bce51a0 Mon Sep 17 00:00:00 2001
From: simonsan <14062932+simonsan@users.noreply.github.com>
Date: Sat, 19 Aug 2023 07:36:10 +0200
Subject: [PATCH 03/26] chore: Implement bug_report template as Github form
---
.github/ISSUE_TEMPLATE/bug_report.md | 55 --------
.github/ISSUE_TEMPLATE/bug_report.yml | 182 ++++++++++++++++++++++++++
2 files changed, 182 insertions(+), 55 deletions(-)
delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.md
create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
deleted file mode 100644
index b9aa60e42..000000000
--- a/.github/ISSUE_TEMPLATE/bug_report.md
+++ /dev/null
@@ -1,55 +0,0 @@
----
-name: Bug report
-about: Create a report to help us improve
-title: ''
-labels: ['S-triage', 'C-bug']
-assignees: ''
-
----
-
-## Describe the bug
-
-A clear and concise description of what the bug is.
-
-### Code sample
-
-```text
-A short code snippet that can be used to reproduce the bug. Do NOT paste screenshots of code!
-```
-
-### To reproduce
-
-Steps to reproduce the behavior, if it's a bug in `rustic_core` or anything code
-related, please provide a reproducible example.
-
-```text
-rustic output here
-```
-
-## Expected behavior
-
-A clear and concise description of what you expected to happen.
-
-## Versions (please complete the following information)
-
-| | |
-| ----------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| Operating System | e.g., Windows 10, MacOS 10.15, Debian 10 |
-| Kernel Version/OS Build | - *nix: run `uname -a` in the terminal,
- Windows: press `Win + R`, enter `System` and copy `OS Build` from Windows specifications (on Win11)
- MacOS: run `uname -av` in the terminal
|
-| rustic version | output of `rustic --version` |
-| Install type | e.g. build from source (from where?), from binary (e.g. package management system, which one?), other (please elaborate) |
-
-## Additional context
-
-Add any other context about the problem here.
-
-## Please confirm
-
-- [ ] I have searched the
- [discussions](https://github.com/rustic-rs/rustic/discussions) and it
- wasn't discussed before.
-- [ ] I have searched the
- [issue list (incl. closed issues](https://github.com/rustic-rs/rustic/issues?q=is%3Aissue)
- and am not opening a duplicate issue.
-- [ ] I have verified the issue still exists in
- [`rustic (beta)` (built from the main branch)](https://github.com/rustic-rs/rustic-beta).
diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml
new file mode 100644
index 000000000..56a2e92cc
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/bug_report.yml
@@ -0,0 +1,182 @@
+name: Bug report
+description: Create a report to help us improve
+labels: ["S-triage", "C-bug"]
+body:
+ - type: markdown
+ attributes:
+ value: |
+ ### Thank you for taking the time to report a bug in `rustic`!
+
+ Please fill out the following template to help us reproduce the issue and fix it as soon as possible.
+
+ - type: markdown
+ attributes:
+ value: |
+ **Please note that this is only for reporting bugs in `rustic` itself. If you have a question about how to use `rustic`, please use the [discussions](https://github.com/rustic-rs/rustic/discussions) instead.**
+
+ - type: checkboxes
+ id: product-scope
+ attributes:
+ label: Which part(s) of the `rustic`` ecosystem are we talking about?
+ description: You may select more than one.
+ options:
+ - label: rustic
+ - label: rustic_beta
+ - label: rustic_core
+
+ - type: textarea
+ id: current-behavior
+ attributes:
+ label: Current Behavior
+ description: A clear and concise description of what you're experiencing and what the bug is.
+ validations:
+ required: true
+
+ - type: textarea
+ id: reproduction-steps
+ attributes:
+ label: Reproduction steps
+ description: How do you trigger this bug? Please walk us through it step by step.
+ value: |
+ 1.
+ 2.
+ 3.
+ ...
+ render: bash
+ validations:
+ required: false
+
+ - type: input
+ id: bug-prevalence
+ attributes:
+ label: Bug prevalence
+ description: How often do you encounter this bug?
+ placeholder: "Example: Whenever I run `rustic restore` (100% of the time), or sometimes when I run `rustic restore` (50% of the time)"
+ validations:
+ required: true
+
+ - type: textarea
+ id: code-sample
+ attributes:
+ label: If it's a bug in `rustic_core` or anything code related, please provide a reproducible example for the bug below.
+ description: A short code snippet that can be used to reproduce the bug. Do NOT paste screenshots of code!
+ render: Rust
+ validations:
+ required: false
+
+ - type: textarea
+ id: expected-behavior
+ attributes:
+ label: Expected Behavior
+ description: A clear and concise description of what you expected to happen.
+ validations:
+ required: true
+
+ - type: markdown
+ attributes:
+ value: |
+ ## Environment
+
+ Please fill out the following information about your environment.
+
+ - type: dropdown
+ id: install-type
+ attributes:
+ label: Where did you get `rustic` from?
+ multiple: false
+ options:
+ - Built from source
+ - Binary from Package-management System
+ - Other (Please specify below)
+ default: 0
+ validations:
+ required: true
+ - type: input
+ id: install-type-other
+ attributes:
+ label: Other install type
+ description: "Where else did you get `rustic` from?"
+ placeholder: "Example: I installed it with `cargo binstall rustic`"
+ validations:
+ required: true
+
+ - type: textarea
+ id: operating-system
+ attributes:
+ label: Operating System
+ description: |
+ Which operating system are you running on? Please be as specific as possible.
+
+ examples:
+ - Windows 10
+ - MacOSX 10.15
+ - Debian 10
+ value: |
+ **Operating System**:
+ validations:
+ required: false
+
+ - type: textarea
+ id: kernel-version
+ attributes:
+ label: Kernel Version/OS Build
+ description: |
+ Which kernel version/OS build are you running on? Please be as specific as possible.
+
+ - *nix: run `uname -a` in the terminal
+ - Windows: press `Win + R`, enter `System` and copy `OS Build` from Windows specifications (on Win11)
+ - MacOS: run `uname -av` in the terminal
+
+ examples:
+ - **Kernel Version**: Linux MyPC 5.15.90.1-microsoft-standard-WSL2 #1 SMP Fri Jan 27 02:56:13 UTC 2023 x86_64 x86_64 x86_64 GNU/Linux
+ - **OS build**: Windows 11 Pro 22H2 Build 22621.2134
+ value: |
+ - **Kernel Version**:
+ - **OS build**:
+ validations:
+ required: false
+
+ - type: textarea
+ id: rustic-version
+ attributes:
+ label: "`rustic` version"
+ description: |
+ Which version of `rustic` are you running? Please be as specific as possible.
+
+ Please run `rustic --version` and copy the output here.
+
+ example:
+ **rustic**: rustic v0.5.4
+ value: |
+ **rustic**:
+ validations:
+ required: false
+
+ - type: textarea
+ id: additional-context
+ attributes:
+ label: Anything else?
+ description: |
+ Links? References? Anything that will give us more context about the issue you are encountering!
+
+ Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in.
+ validations:
+ required: false
+
+ - type: checkboxes
+ id: checklist-confirmation
+ attributes:
+ label: Checklist
+ description: |
+ Please check the following:
+ options:
+ - label: I have searched the [discussions](https://github.com/rustic-rs/rustic/discussions) and it wasn't discussed before.
+ required: true
+ - label: I have searched the [issue list (incl. closed issues](https://github.com/rustic-rs/rustic/issues?q=is%3Aissue) and am not opening a duplicate issue.
+ required: true
+ - label: I have verified the issue still exists in [`rustic (beta)` (built from the main branch)](https://github.com/rustic-rs/rustic-beta).
+ required: true
+
+ - type: markdown
+ attributes:
+ value: "Thanks for the report! We'll look into it as soon as possible."
From 8ba7553e4ebd4c3c3266e6ebdcec91b00eceb478 Mon Sep 17 00:00:00 2001
From: simonsan <14062932+simonsan@users.noreply.github.com>
Date: Sat, 19 Aug 2023 07:43:37 +0200
Subject: [PATCH 04/26] chore: fix issues with template
---
.github/ISSUE_TEMPLATE/bug_report.yml | 48 +++++++++++----------------
1 file changed, 20 insertions(+), 28 deletions(-)
diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml
index 56a2e92cc..47272789e 100644
--- a/.github/ISSUE_TEMPLATE/bug_report.yml
+++ b/.github/ISSUE_TEMPLATE/bug_report.yml
@@ -5,19 +5,21 @@ body:
- type: markdown
attributes:
value: |
- ### Thank you for taking the time to report a bug in `rustic`!
+ ### Thank you for taking the time to report a bug in **rustic**!
Please fill out the following template to help us reproduce the issue and fix it as soon as possible.
- type: markdown
attributes:
value: |
- **Please note that this is only for reporting bugs in `rustic` itself. If you have a question about how to use `rustic`, please use the [discussions](https://github.com/rustic-rs/rustic/discussions) instead.**
+ **Please note that this is only for reporting bugs in **rustic** itself.
+
+ If you have a question about how to use **rustic**, please use the [discussions](https://github.com/rustic-rs/rustic/discussions) instead.**
- type: checkboxes
id: product-scope
attributes:
- label: Which part(s) of the `rustic`` ecosystem are we talking about?
+ label: Which part(s) of the **rustic** ecosystem are we talking about?
description: You may select more than one.
options:
- label: rustic
@@ -46,7 +48,7 @@ body:
validations:
required: false
- - type: input
+ - type: textarea
id: bug-prevalence
attributes:
label: Bug prevalence
@@ -82,7 +84,7 @@ body:
- type: dropdown
id: install-type
attributes:
- label: Where did you get `rustic` from?
+ label: Where did you get **rustic** from?
multiple: false
options:
- Built from source
@@ -95,24 +97,8 @@ body:
id: install-type-other
attributes:
label: Other install type
- description: "Where else did you get `rustic` from?"
+ description: "Where else did you get **rustic** from?"
placeholder: "Example: I installed it with `cargo binstall rustic`"
- validations:
- required: true
-
- - type: textarea
- id: operating-system
- attributes:
- label: Operating System
- description: |
- Which operating system are you running on? Please be as specific as possible.
-
- examples:
- - Windows 10
- - MacOSX 10.15
- - Debian 10
- value: |
- **Operating System**:
validations:
required: false
@@ -128,13 +114,15 @@ body:
- MacOS: run `uname -av` in the terminal
examples:
+ - **Operating System**: Windows 10
- **Kernel Version**: Linux MyPC 5.15.90.1-microsoft-standard-WSL2 #1 SMP Fri Jan 27 02:56:13 UTC 2023 x86_64 x86_64 x86_64 GNU/Linux
- **OS build**: Windows 11 Pro 22H2 Build 22621.2134
value: |
+ - **Operating System**:
- **Kernel Version**:
- **OS build**:
validations:
- required: false
+ required: true
- type: textarea
id: rustic-version
@@ -150,7 +138,7 @@ body:
value: |
**rustic**:
validations:
- required: false
+ required: true
- type: textarea
id: additional-context
@@ -170,13 +158,17 @@ body:
description: |
Please check the following:
options:
- - label: I have searched the [discussions](https://github.com/rustic-rs/rustic/discussions) and it wasn't discussed before.
+ - label: |
+ I have searched the [discussions](https://github.com/rustic-rs/rustic/discussions) and it wasn't discussed before.
required: true
- - label: I have searched the [issue list (incl. closed issues](https://github.com/rustic-rs/rustic/issues?q=is%3Aissue) and am not opening a duplicate issue.
+ - label: |
+ I have searched the [issue list (incl. closed issues](https://github.com/rustic-rs/rustic/issues?q=is%3Aissue) and am not opening a duplicate issue.
required: true
- - label: I have verified the issue still exists in [`rustic (beta)` (built from the main branch)](https://github.com/rustic-rs/rustic-beta).
+ - label: |
+ I have verified the issue still exists in [`rustic (beta)` (built from the main branch)](https://github.com/rustic-rs/rustic-beta).
required: true
- type: markdown
attributes:
- value: "Thanks for the report! We'll look into it as soon as possible."
+ value: |
+ ## Thanks for the report! We'll look into it as soon as possible.
From 9a43e33831c09efaf7a55676b8562752d79870ec Mon Sep 17 00:00:00 2001
From: simonsan <14062932+simonsan@users.noreply.github.com>
Date: Sat, 19 Aug 2023 07:44:28 +0200
Subject: [PATCH 05/26] fix headline
---
.github/ISSUE_TEMPLATE/bug_report.yml | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml
index 47272789e..af2df4e1b 100644
--- a/.github/ISSUE_TEMPLATE/bug_report.yml
+++ b/.github/ISSUE_TEMPLATE/bug_report.yml
@@ -12,9 +12,9 @@ body:
- type: markdown
attributes:
value: |
- **Please note that this is only for reporting bugs in **rustic** itself.
+ ## Please note that this is only for reporting bugs in **rustic** itself.
- If you have a question about how to use **rustic**, please use the [discussions](https://github.com/rustic-rs/rustic/discussions) instead.**
+ ## If you have a question about how to use **rustic**, please use the [discussions](https://github.com/rustic-rs/rustic/discussions) instead.**
- type: checkboxes
id: product-scope
From 0cb20388a11ae60da64c3424a65e5c3f428c082a Mon Sep 17 00:00:00 2001
From: simonsan <14062932+simonsan@users.noreply.github.com>
Date: Sat, 19 Aug 2023 07:44:50 +0200
Subject: [PATCH 06/26] fix headline
---
.github/ISSUE_TEMPLATE/bug_report.yml | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml
index af2df4e1b..0e2957dc2 100644
--- a/.github/ISSUE_TEMPLATE/bug_report.yml
+++ b/.github/ISSUE_TEMPLATE/bug_report.yml
@@ -5,16 +5,16 @@ body:
- type: markdown
attributes:
value: |
- ### Thank you for taking the time to report a bug in **rustic**!
+ ## Thank you for taking the time to report a bug in **rustic**!
Please fill out the following template to help us reproduce the issue and fix it as soon as possible.
- type: markdown
attributes:
value: |
- ## Please note that this is only for reporting bugs in **rustic** itself.
+ ### Please note that this is only for reporting bugs in **rustic** itself.
- ## If you have a question about how to use **rustic**, please use the [discussions](https://github.com/rustic-rs/rustic/discussions) instead.**
+ ### If you have a question about how to use **rustic**, please use the [discussions](https://github.com/rustic-rs/rustic/discussions) instead.**
- type: checkboxes
id: product-scope
From 88d05b8f89a1ebed7b7ea3377ff0b8a43296de56 Mon Sep 17 00:00:00 2001
From: simonsan <14062932+simonsan@users.noreply.github.com>
Date: Sat, 19 Aug 2023 07:49:12 +0200
Subject: [PATCH 07/26] fix smaller issues
---
.github/ISSUE_TEMPLATE/bug_report.yml | 32 +++++++++++++--------------
1 file changed, 16 insertions(+), 16 deletions(-)
diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml
index 0e2957dc2..eefce8c92 100644
--- a/.github/ISSUE_TEMPLATE/bug_report.yml
+++ b/.github/ISSUE_TEMPLATE/bug_report.yml
@@ -14,12 +14,12 @@ body:
value: |
### Please note that this is only for reporting bugs in **rustic** itself.
- ### If you have a question about how to use **rustic**, please use the [discussions](https://github.com/rustic-rs/rustic/discussions) instead.**
+ ### If you have a question about how to use **rustic**, please use the [discussions](https://github.com/rustic-rs/rustic/discussions) instead.
- type: checkboxes
id: product-scope
attributes:
- label: Which part(s) of the **rustic** ecosystem are we talking about?
+ label: Which part(s) of the rustic ecosystem are we talking about?
description: You may select more than one.
options:
- label: rustic
@@ -60,7 +60,7 @@ body:
- type: textarea
id: code-sample
attributes:
- label: If it's a bug in `rustic_core` or anything code related, please provide a reproducible example for the bug below.
+ label: If it's a bug in rustic_core or anything code related, please provide a reproducible example for the bug below.
description: A short code snippet that can be used to reproduce the bug. Do NOT paste screenshots of code!
render: Rust
validations:
@@ -84,7 +84,7 @@ body:
- type: dropdown
id: install-type
attributes:
- label: Where did you get **rustic** from?
+ label: Where did you get rustic from?
multiple: false
options:
- Built from source
@@ -98,7 +98,7 @@ body:
attributes:
label: Other install type
description: "Where else did you get **rustic** from?"
- placeholder: "Example: I installed it with `cargo binstall rustic`"
+ placeholder: "Example: I installed it with `cargo binstall rustic`."
validations:
required: false
@@ -109,14 +109,14 @@ body:
description: |
Which kernel version/OS build are you running on? Please be as specific as possible.
- - *nix: run `uname -a` in the terminal
- - Windows: press `Win + R`, enter `System` and copy `OS Build` from Windows specifications (on Win11)
- - MacOS: run `uname -av` in the terminal
+ - *nix: run `uname -a` in the terminal
+ - Windows: press `Win + R`, enter `System` and copy `OS Build` from Windows specifications (on Win11)
+ - MacOS: run `uname -av` in the terminal
- examples:
- - **Operating System**: Windows 10
- - **Kernel Version**: Linux MyPC 5.15.90.1-microsoft-standard-WSL2 #1 SMP Fri Jan 27 02:56:13 UTC 2023 x86_64 x86_64 x86_64 GNU/Linux
- - **OS build**: Windows 11 Pro 22H2 Build 22621.2134
+ examples:
+ - **Operating System**: Windows 10
+ - **Kernel Version**: Linux MyPC 5.15.90.1-microsoft-standard-WSL2 #1 SMP Fri Jan 27 02:56:13 UTC 2023 x86_64 x86_64 x86_64 GNU/Linux
+ - **OS build**: Windows 11 Pro 22H2 Build 22621.2134
value: |
- **Operating System**:
- **Kernel Version**:
@@ -131,10 +131,10 @@ body:
description: |
Which version of `rustic` are you running? Please be as specific as possible.
- Please run `rustic --version` and copy the output here.
+ Please run `rustic --version` and copy the output here.
- example:
- **rustic**: rustic v0.5.4
+ example:
+ **rustic**: rustic v0.5.4
value: |
**rustic**:
validations:
@@ -165,7 +165,7 @@ body:
I have searched the [issue list (incl. closed issues](https://github.com/rustic-rs/rustic/issues?q=is%3Aissue) and am not opening a duplicate issue.
required: true
- label: |
- I have verified the issue still exists in [`rustic (beta)` (built from the main branch)](https://github.com/rustic-rs/rustic-beta).
+ I have verified the issue still exists in [rustic_beta (built from the main branch)](https://github.com/rustic-rs/rustic-beta).
required: true
- type: markdown
From aca3b0408d107ffb02a577b9187b04552e1e0337 Mon Sep 17 00:00:00 2001
From: simonsan <14062932+simonsan@users.noreply.github.com>
Date: Sat, 19 Aug 2023 08:29:47 +0200
Subject: [PATCH 08/26] add feature request template and refine issue template
---
.github/ISSUE_TEMPLATE/bug_report.yml | 51 +++++++
.github/ISSUE_TEMPLATE/feature_request.md | 31 ----
.github/ISSUE_TEMPLATE/feature_request.yml | 168 +++++++++++++++++++++
3 files changed, 219 insertions(+), 31 deletions(-)
delete mode 100644 .github/ISSUE_TEMPLATE/feature_request.md
create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yml
diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml
index eefce8c92..033f7cb96 100644
--- a/.github/ISSUE_TEMPLATE/bug_report.yml
+++ b/.github/ISSUE_TEMPLATE/bug_report.yml
@@ -168,6 +168,57 @@ body:
I have verified the issue still exists in [rustic_beta (built from the main branch)](https://github.com/rustic-rs/rustic-beta).
required: true
+ - type: dropdown
+ id: user-friendliness
+ attributes:
+ label: |
+ How would you rate the ease of use of rustic?
+ description: |
+ Consider a scale from -2 (Very difficult) to +2 (Very easy).
+ options:
+ - "-2 - Very Difficult"
+ - "-1 - Difficult"
+ - "0 - Neutral"
+ - "+1 - Easy"
+ - "+2 - Very Easy"
+ default: 3
+ validations:
+ required: true
+
+ - type: dropdown
+ id: clarity-of-information
+ attributes:
+ label: |
+ Was the information and feedback provided by rustic clear and understandable?
+ description: |
+ Consider a scale from -2 (Very unclear) to +2 (Very clear).
+ options:
+ - "-2 - Very Unclear"
+ - "-1 - Somewhat Unclear"
+ - "0 - Neutral"
+ - "+1 - Clear"
+ - "+2 - Very Clear"
+ default: 3
+ validations:
+ required: true
+
+ - type: dropdown
+ id: satisfaction
+ attributes:
+ label: |
+ Overall, how satisfied are you with rustic?
+ description: |
+ Consider a scale from -2 (I'm mad as hell, and I can't take it anymore) to +2 (I can't go back to any other backup solution anymore).
+ options:
+ - "-2 - Very Dissatisfied"
+ - "-1 - Dissatisfied "
+ - "0 - Neutral"
+ - "+1 - Satisfied"
+ - "+2 - Very Satisfied"
+ default: 3
+ validations:
+ required: true
+
- type: markdown
attributes:
value: |
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
deleted file mode 100644
index 040ca781a..000000000
--- a/.github/ISSUE_TEMPLATE/feature_request.md
+++ /dev/null
@@ -1,31 +0,0 @@
----
-name: Feature request
-about: "Create a feature requests to let us know what you wish us to improve. Please search for existing issues first. Also see our CONTRIBUTING.md."
-title: ''
-labels: ['S-triage', 'C-enhancement']
-assignees: ''
----
-
-### Please Describe The Problem To Be Solved
-
-
-
-### (Optional): Suggest A Solution
-
-
diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml
new file mode 100644
index 000000000..fed30cfee
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/feature_request.yml
@@ -0,0 +1,168 @@
+name: Feature request
+description: |
+ Create a feature requests to let us know what you wish us to improve. Please search for existing issues first. Also see our CONTRIBUTING.md.
+labels: ["S-triage", "C-enhancement"]
+body:
+ - type: markdown
+ attributes:
+ value: |
+ ## Thank you for taking the time to propose a new feature to **rustic**!
+
+ Please fill out the following template to help us understanding why you think this feature is needed for rustic.
+
+ - type: markdown
+ attributes:
+ value: |
+ ### Please note that this is only for proposing new features to **rustic** itself.
+
+ ### If you have a question about how to use **rustic**, please use the [discussions](https://github.com/rustic-rs/rustic/discussions) instead.
+
+ - type: checkboxes
+ id: product-scope
+ attributes:
+ label: Which part(s) of the rustic ecosystem are we talking about?
+ description: You may select more than one.
+ options:
+ - label: rustic
+ - label: rustic_beta
+ - label: rustic_core
+
+ - type: textarea
+ id: current-behavior
+ attributes:
+ label: Current Behavior
+ description: A clear and concise description of what you're experiencing and what you are missing out on.
+ validations:
+ required: false
+
+ - type: textarea
+ id: problem-to-be-solved
+ attributes:
+ label: Problem to be solved
+ description: |
+ Please present a concise description of the problem to be addressed by this feature request.
+
+ Please be clear what parts of the problem are considered to be in-scope and out-of-scope.
+ validations:
+ required: true
+
+ - type: textarea
+ id: user-stories
+ attributes:
+ label: User stories
+ description: |
+ Can you provide us with at least one user story?
+
+ A user story is a description of a particular use case of the feature.
+ It describes the type of user (you), what they want and why.
+
+ A simple template is:
+
+ "As a < type of user >, I want to < some goal > so that I (can) < some reason >."
+ value: |
+ As a < type of user >, I want to < some goal > so that I (can) < some reason >.
+ validations:
+ required: false
+
+ - type: markdown
+ attributes:
+ value: |
+ ## Solution
+
+ - type: textarea
+ id: user-solution
+ attributes:
+ label: Suggest a solution
+ description: |
+ A concise description of your preferred solution.
+
+ Things to address include:
+
+ * Details of the technical implementation
+ * Tradeoffs made in design decisions
+ * Caveats and considerations for the future
+
+ If there are multiple solutions, please present each one separately.
+ Save comparisons for the very end.
+ validations:
+ required: false
+
+ - type: dropdown
+ id: install-type
+ attributes:
+ label: Where did you get rustic from?
+ multiple: false
+ options:
+ - Built from source
+ - Binary from Package-management System
+ - Other (Please specify below)
+ default: 0
+ validations:
+ required: true
+
+ - type: textarea
+ id: additional-context
+ attributes:
+ label: Anything else?
+ description: |
+ Links? References? Anything that will give us more context about the proposal you are making!
+
+ Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in.
+ validations:
+ required: false
+
+ - type: dropdown
+ id: user-friendliness
+ attributes:
+ label: |
+ How would you rate the ease of use of rustic?
+ description: |
+ Consider a scale from -2 (Very difficult) to +2 (Very easy).
+ options:
+ - "-2 - Very Difficult"
+ - "-1 - Difficult"
+ - "0 - Neutral"
+ - "+1 - Easy"
+ - "+2 - Very Easy"
+ default: 3
+ validations:
+ required: true
+
+ - type: dropdown
+ id: clarity-of-information
+ attributes:
+ label: |
+ Was the information and feedback provided by rustic clear and understandable?
+ description: |
+ Consider a scale from -2 (Very unclear) to +2 (Very clear).
+ options:
+ - "-2 - Very Unclear"
+ - "-1 - Somewhat Unclear"
+ - "0 - Neutral"
+ - "+1 - Clear"
+ - "+2 - Very Clear"
+ default: 3
+ validations:
+ required: true
+
+ - type: dropdown
+ id: satisfaction
+ attributes:
+ label: |
+ Overall, how satisfied are you with rustic?
+ description: |
+ Consider a scale from -2 (I'm mad as hell, and I can't take it anymore) to +2 (I can't go back to any other backup solution anymore).
+ options:
+ - "-2 - Very Dissatisfied"
+ - "-1 - Dissatisfied "
+ - "0 - Neutral"
+ - "+1 - Satisfied"
+ - "+2 - Very Satisfied"
+ default: 3
+ validations:
+ required: true
+
+ - type: markdown
+ attributes:
+ value: |
+ ## Thank you for the feature request! We'll look into this as soon as possible.
From 2a04ee7d0546a54bac90580fcc81bb9dbb8b70c8 Mon Sep 17 00:00:00 2001
From: simonsan <14062932+simonsan@users.noreply.github.com>
Date: Sun, 20 Aug 2023 19:35:21 +0200
Subject: [PATCH 09/26] style: remove unneeded headlines
---
.github/ISSUE_TEMPLATE/bug_report.yml | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml
index 033f7cb96..20e08664a 100644
--- a/.github/ISSUE_TEMPLATE/bug_report.yml
+++ b/.github/ISSUE_TEMPLATE/bug_report.yml
@@ -12,9 +12,9 @@ body:
- type: markdown
attributes:
value: |
- ### Please note that this is only for reporting bugs in **rustic** itself.
+ Please note that this is only for reporting bugs in **rustic** itself.
- ### If you have a question about how to use **rustic**, please use the [discussions](https://github.com/rustic-rs/rustic/discussions) instead.
+ If you have a question about how to use **rustic**, please use the [discussions](https://github.com/rustic-rs/rustic/discussions) instead.
- type: checkboxes
id: product-scope
From c2b3d320671d746a4efea09a0595fdaffea17f39 Mon Sep 17 00:00:00 2001
From: simonsan <14062932+simonsan@users.noreply.github.com>
Date: Sun, 20 Aug 2023 19:37:21 +0200
Subject: [PATCH 10/26] style: remove unneeded headlines
---
.github/ISSUE_TEMPLATE/feature_request.yml | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml
index fed30cfee..1650f31e0 100644
--- a/.github/ISSUE_TEMPLATE/feature_request.yml
+++ b/.github/ISSUE_TEMPLATE/feature_request.yml
@@ -13,9 +13,9 @@ body:
- type: markdown
attributes:
value: |
- ### Please note that this is only for proposing new features to **rustic** itself.
+ Please note that this is only for proposing new features to **rustic** itself.
- ### If you have a question about how to use **rustic**, please use the [discussions](https://github.com/rustic-rs/rustic/discussions) instead.
+ If you have a question about how to use **rustic**, please use the [discussions](https://github.com/rustic-rs/rustic/discussions) instead.
- type: checkboxes
id: product-scope
From 8d30e5ae4c24e405d2300f6484ca97688d005719 Mon Sep 17 00:00:00 2001
From: simonsan <14062932+simonsan@users.noreply.github.com>
Date: Sun, 20 Aug 2023 19:38:34 +0200
Subject: [PATCH 11/26] style: use input for rustic_version for space reasons
---
.github/ISSUE_TEMPLATE/bug_report.yml | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml
index 20e08664a..7405ddd36 100644
--- a/.github/ISSUE_TEMPLATE/bug_report.yml
+++ b/.github/ISSUE_TEMPLATE/bug_report.yml
@@ -124,7 +124,7 @@ body:
validations:
required: true
- - type: textarea
+ - type: input
id: rustic-version
attributes:
label: "`rustic` version"
From 109759e003cfdf6f0d49b0a207923b3aecfee8dc Mon Sep 17 00:00:00 2001
From: simonsan <14062932+simonsan@users.noreply.github.com>
Date: Sun, 20 Aug 2023 19:40:09 +0200
Subject: [PATCH 12/26] fix: try to fix md-links in checkboxes
---
.github/ISSUE_TEMPLATE/bug_report.yml | 9 +++------
1 file changed, 3 insertions(+), 6 deletions(-)
diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml
index 7405ddd36..33637c7e6 100644
--- a/.github/ISSUE_TEMPLATE/bug_report.yml
+++ b/.github/ISSUE_TEMPLATE/bug_report.yml
@@ -158,14 +158,11 @@ body:
description: |
Please check the following:
options:
- - label: |
- I have searched the [discussions](https://github.com/rustic-rs/rustic/discussions) and it wasn't discussed before.
+ - label: "I have searched the [discussions](https://github.com/rustic-rs/rustic/discussions) and it wasn't discussed before."
required: true
- - label: |
- I have searched the [issue list (incl. closed issues](https://github.com/rustic-rs/rustic/issues?q=is%3Aissue) and am not opening a duplicate issue.
+ - label: "I have searched the [issue list (incl. closed issues](https://github.com/rustic-rs/rustic/issues?q=is%3Aissue) and am not opening a duplicate issue."
required: true
- - label: |
- I have verified the issue still exists in [rustic_beta (built from the main branch)](https://github.com/rustic-rs/rustic-beta).
+ - label: "I have verified the issue still exists in [rustic_beta (built from the main branch)](https://github.com/rustic-rs/rustic-beta).""
required: true
- type: dropdown
From 48cc34dbb594756e53a19e89a6de425627983793 Mon Sep 17 00:00:00 2001
From: simonsan <14062932+simonsan@users.noreply.github.com>
Date: Sun, 20 Aug 2023 19:41:25 +0200
Subject: [PATCH 13/26] fix: try to fix md-links in checkboxes
---
.github/ISSUE_TEMPLATE/bug_report.yml | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml
index 33637c7e6..4303a346e 100644
--- a/.github/ISSUE_TEMPLATE/bug_report.yml
+++ b/.github/ISSUE_TEMPLATE/bug_report.yml
@@ -162,7 +162,7 @@ body:
required: true
- label: "I have searched the [issue list (incl. closed issues](https://github.com/rustic-rs/rustic/issues?q=is%3Aissue) and am not opening a duplicate issue."
required: true
- - label: "I have verified the issue still exists in [rustic_beta (built from the main branch)](https://github.com/rustic-rs/rustic-beta).""
+ - label: "I have verified the issue still exists in [rustic_beta (built from the main branch)](https://github.com/rustic-rs/rustic-beta)."
required: true
- type: dropdown
From 16743b2ed9469a007edceafc7263341482fdf98f Mon Sep 17 00:00:00 2001
From: simonsan <14062932+simonsan@users.noreply.github.com>
Date: Sun, 20 Aug 2023 19:43:40 +0200
Subject: [PATCH 14/26] try html in checkbox
---
.github/ISSUE_TEMPLATE/bug_report.yml | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml
index 4303a346e..3747f0743 100644
--- a/.github/ISSUE_TEMPLATE/bug_report.yml
+++ b/.github/ISSUE_TEMPLATE/bug_report.yml
@@ -158,7 +158,7 @@ body:
description: |
Please check the following:
options:
- - label: "I have searched the [discussions](https://github.com/rustic-rs/rustic/discussions) and it wasn't discussed before."
+ - label: "I have searched the discussions and it wasn't discussed before."
required: true
- label: "I have searched the [issue list (incl. closed issues](https://github.com/rustic-rs/rustic/issues?q=is%3Aissue) and am not opening a duplicate issue."
required: true
From 842d5de89c4123c8b771dfdc8a2ec7f1c0eceedc Mon Sep 17 00:00:00 2001
From: simonsan <14062932+simonsan@users.noreply.github.com>
Date: Sun, 20 Aug 2023 19:47:39 +0200
Subject: [PATCH 15/26] move md-links into description
---
.github/ISSUE_TEMPLATE/bug_report.yml | 10 +++++++---
1 file changed, 7 insertions(+), 3 deletions(-)
diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml
index 3747f0743..bff730f48 100644
--- a/.github/ISSUE_TEMPLATE/bug_report.yml
+++ b/.github/ISSUE_TEMPLATE/bug_report.yml
@@ -157,12 +157,16 @@ body:
label: Checklist
description: |
Please check the following:
+
+ * [discussions](https://github.com/rustic-rs/rustic/discussions)
+ * [issue list (incl. closed issues](https://github.com/rustic-rs/rustic/issues?q=is%3Aissue)
+ * [rustic_beta (built from the main branch)](https://github.com/rustic-rs/rustic-beta)
options:
- - label: "I have searched the discussions and it wasn't discussed before."
+ - label: "I have searched the discussions (see link in description) and it wasn't discussed before."
required: true
- - label: "I have searched the [issue list (incl. closed issues](https://github.com/rustic-rs/rustic/issues?q=is%3Aissue) and am not opening a duplicate issue."
+ - label: "I have searched the issue list (see link in description) and am not opening a duplicate issue."
required: true
- - label: "I have verified the issue still exists in [rustic_beta (built from the main branch)](https://github.com/rustic-rs/rustic-beta)."
+ - label: "I have verified the issue still exists in rustic_beta (see link in description)."
required: true
- type: dropdown
From 8d3836cb1ad524e42267d92ed63183c127952b68 Mon Sep 17 00:00:00 2001
From: simonsan <14062932+simonsan@users.noreply.github.com>
Date: Sun, 20 Aug 2023 19:50:38 +0200
Subject: [PATCH 16/26] move link to extra text
---
.github/ISSUE_TEMPLATE/bug_report.yml | 19 ++++++++++++-------
1 file changed, 12 insertions(+), 7 deletions(-)
diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml
index bff730f48..780b744ef 100644
--- a/.github/ISSUE_TEMPLATE/bug_report.yml
+++ b/.github/ISSUE_TEMPLATE/bug_report.yml
@@ -151,22 +151,27 @@ body:
validations:
required: false
+ - type: markdown
+ attributes:
+ value: |
+ Please make sure, you have searched the following resources before submitting this issue:
+
+ * search [discussions](https://github.com/rustic-rs/rustic/discussions)
+ * search [issue list (incl. closed issues)](https://github.com/rustic-rs/rustic/issues?q=is%3Aissue)
+ * verify issue still exists in [rustic_beta (built from the main branch)](https://github.com/rustic-rs/rustic-beta)
+
- type: checkboxes
id: checklist-confirmation
attributes:
label: Checklist
description: |
Please check the following:
-
- * [discussions](https://github.com/rustic-rs/rustic/discussions)
- * [issue list (incl. closed issues](https://github.com/rustic-rs/rustic/issues?q=is%3Aissue)
- * [rustic_beta (built from the main branch)](https://github.com/rustic-rs/rustic-beta)
options:
- - label: "I have searched the discussions (see link in description) and it wasn't discussed before."
+ - label: "I have searched the discussions (see link above) and it wasn't discussed before."
required: true
- - label: "I have searched the issue list (see link in description) and am not opening a duplicate issue."
+ - label: "I have searched the issue list (see link above) and am not opening a duplicate issue."
required: true
- - label: "I have verified the issue still exists in rustic_beta (see link in description)."
+ - label: "I have verified the issue still exists in rustic_beta (see link above)."
required: true
- type: dropdown
From bdd5060abc8b828101918b30cc60f56bd67a032d Mon Sep 17 00:00:00 2001
From: simonsan <14062932+simonsan@users.noreply.github.com>
Date: Sun, 20 Aug 2023 19:55:21 +0200
Subject: [PATCH 17/26] fix order
---
.github/ISSUE_TEMPLATE/bug_report.yml | 45 ++++++++++++++++-----------
1 file changed, 27 insertions(+), 18 deletions(-)
diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml
index 780b744ef..b9cb23f24 100644
--- a/.github/ISSUE_TEMPLATE/bug_report.yml
+++ b/.github/ISSUE_TEMPLATE/bug_report.yml
@@ -154,25 +154,9 @@ body:
- type: markdown
attributes:
value: |
- Please make sure, you have searched the following resources before submitting this issue:
+ ## Questionnaire
- * search [discussions](https://github.com/rustic-rs/rustic/discussions)
- * search [issue list (incl. closed issues)](https://github.com/rustic-rs/rustic/issues?q=is%3Aissue)
- * verify issue still exists in [rustic_beta (built from the main branch)](https://github.com/rustic-rs/rustic-beta)
-
- - type: checkboxes
- id: checklist-confirmation
- attributes:
- label: Checklist
- description: |
- Please check the following:
- options:
- - label: "I have searched the discussions (see link above) and it wasn't discussed before."
- required: true
- - label: "I have searched the issue list (see link above) and am not opening a duplicate issue."
- required: true
- - label: "I have verified the issue still exists in rustic_beta (see link above)."
- required: true
+ Please fill out the following questionnaire to help us improve **rustic**.
- type: dropdown
id: user-friendliness
@@ -225,6 +209,31 @@ body:
validations:
required: true
+ - type: markdown
+ attributes:
+ value: |
+ Please make sure, you have searched/tried the following resources before submitting this issue:
+
+ * search [discussions](https://github.com/rustic-rs/rustic/discussions)
+ * search [issue list (incl. closed issues)](https://github.com/rustic-rs/rustic/issues?q=is%3Aissue)
+ * verify issue still exists in [rustic_beta (built from the main branch)](https://github.com/rustic-rs/rustic-beta)
+
+ - type: checkboxes
+ id: checklist-confirmation
+ attributes:
+ label: Checklist
+ description: |
+ Please check the following:
+ options:
+ - label: "I have verified that I am using the latest stable version of rustic."
+ required: true
+ - label: "I have searched the discussions (see link above) and it wasn't discussed before."
+ required: true
+ - label: "I have searched the issue list (see link above) and am not opening a duplicate issue."
+ required: true
+ - label: "I have verified the issue still exists in rustic_beta (see link above)."
+ required: true
+
- type: markdown
attributes:
value: |
From 03e0b35abde46e143ab6733609c7e14dff87fdde Mon Sep 17 00:00:00 2001
From: simonsan <14062932+simonsan@users.noreply.github.com>
Date: Sun, 20 Aug 2023 19:56:36 +0200
Subject: [PATCH 18/26] put links below
---
.github/ISSUE_TEMPLATE/bug_report.yml | 24 ++++++++++++------------
1 file changed, 12 insertions(+), 12 deletions(-)
diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml
index b9cb23f24..222f77172 100644
--- a/.github/ISSUE_TEMPLATE/bug_report.yml
+++ b/.github/ISSUE_TEMPLATE/bug_report.yml
@@ -209,15 +209,6 @@ body:
validations:
required: true
- - type: markdown
- attributes:
- value: |
- Please make sure, you have searched/tried the following resources before submitting this issue:
-
- * search [discussions](https://github.com/rustic-rs/rustic/discussions)
- * search [issue list (incl. closed issues)](https://github.com/rustic-rs/rustic/issues?q=is%3Aissue)
- * verify issue still exists in [rustic_beta (built from the main branch)](https://github.com/rustic-rs/rustic-beta)
-
- type: checkboxes
id: checklist-confirmation
attributes:
@@ -227,13 +218,22 @@ body:
options:
- label: "I have verified that I am using the latest stable version of rustic."
required: true
- - label: "I have searched the discussions (see link above) and it wasn't discussed before."
+ - label: "I have searched the discussions (see link below) and it wasn't discussed before."
required: true
- - label: "I have searched the issue list (see link above) and am not opening a duplicate issue."
+ - label: "I have searched the issue list (see link below) and am not opening a duplicate issue."
required: true
- - label: "I have verified the issue still exists in rustic_beta (see link above)."
+ - label: "I have verified the issue still exists in rustic_beta (see link below)."
required: true
+ - type: markdown
+ attributes:
+ value: |
+ Please make sure, you have searched/tried the following resources before submitting this issue:
+
+ * search [discussions](https://github.com/rustic-rs/rustic/discussions)
+ * search [issue list (incl. closed issues)](https://github.com/rustic-rs/rustic/issues?q=is%3Aissue)
+ * verify issue still exists in [rustic_beta (built from the main branch)](https://github.com/rustic-rs/rustic-beta)
+
- type: markdown
attributes:
value: |
From 7da75553d70d4695ddb69adca880a476f1a1ec48 Mon Sep 17 00:00:00 2001
From: simonsan <14062932+simonsan@users.noreply.github.com>
Date: Sun, 20 Aug 2023 19:57:21 +0200
Subject: [PATCH 19/26] newline in thank you not
---
.github/ISSUE_TEMPLATE/bug_report.yml | 4 +++-
1 file changed, 3 insertions(+), 1 deletion(-)
diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml
index 222f77172..e3bdc2690 100644
--- a/.github/ISSUE_TEMPLATE/bug_report.yml
+++ b/.github/ISSUE_TEMPLATE/bug_report.yml
@@ -237,4 +237,6 @@ body:
- type: markdown
attributes:
value: |
- ## Thanks for the report! We'll look into it as soon as possible.
+ ## Thank you for the report!
+
+ ### We'll look into it as soon as possible.
From 2cb623eb048fc24fa64e6f147453def58320ccc3 Mon Sep 17 00:00:00 2001
From: simonsan <14062932+simonsan@users.noreply.github.com>
Date: Sun, 20 Aug 2023 19:59:23 +0200
Subject: [PATCH 20/26] fix feature request
---
.github/ISSUE_TEMPLATE/feature_request.yml | 24 +++++++++-------------
1 file changed, 10 insertions(+), 14 deletions(-)
diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml
index 1650f31e0..b44e9334f 100644
--- a/.github/ISSUE_TEMPLATE/feature_request.yml
+++ b/.github/ISSUE_TEMPLATE/feature_request.yml
@@ -87,19 +87,6 @@ body:
validations:
required: false
- - type: dropdown
- id: install-type
- attributes:
- label: Where did you get rustic from?
- multiple: false
- options:
- - Built from source
- - Binary from Package-management System
- - Other (Please specify below)
- default: 0
- validations:
- required: true
-
- type: textarea
id: additional-context
attributes:
@@ -111,6 +98,13 @@ body:
validations:
required: false
+ - type: markdown
+ attributes:
+ value: |
+ ## Questionnaire
+
+ Please fill out the following questionnaire to help us improve **rustic**.
+
- type: dropdown
id: user-friendliness
attributes:
@@ -165,4 +159,6 @@ body:
- type: markdown
attributes:
value: |
- ## Thank you for the feature request! We'll look into this as soon as possible.
+ ## Thank you for the feature request!
+
+ ### We'll look into this as soon as possible.
From a5d0e10d89351848897b9b2470cf339656f9102f Mon Sep 17 00:00:00 2001
From: simonsan <14062932+simonsan@users.noreply.github.com>
Date: Sun, 20 Aug 2023 20:01:26 +0200
Subject: [PATCH 21/26] fix lint and checklist item order
---
.github/PULL_REQUEST_TEMPLATE/pull_request_template.md | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md
index b2fe67bba..66014ac64 100644
--- a/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md
+++ b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md
@@ -2,7 +2,7 @@
Please provide a related issue number if applicable. If not, please create one first.
-->
-Here is the issue related to this PR: (Replace this with the corresponding issue number)
+### Here is the issue related to this PR: (Replace this with the corresponding issue number)
+contributions will be licensed under:
+
### Checklist
- [ ] I have read the [CONTRIBUTING.md](/CONTRIBUTING.md) document.
- [ ] I have added myself to the [AUTHORS.md](/AUTHORS.md) file.
+- [ ] I grant the project the right to include and distribute the code under the
+ [Apache License, Version 2.0](./LICENSE-APACHE) and the
+ [MIT license](./LICENSE-MIT) license (and I have the right to grant these
+ rights).
- [ ] I have added tests to cover my changes.
- [ ] All new and existing tests passed.
- [ ] I have updated the documentation accordingly.
diff --git a/AUTHORS.md b/AUTHORS.md
index f68d11252..6b254deeb 100644
--- a/AUTHORS.md
+++ b/AUTHORS.md
@@ -3,6 +3,11 @@
Everyone who has contributed to the `rustic` project is listed here. By adding
your name to this list, you agree to the license terms of this project.
+You agree, that your contributions will be licensed under:
+
+- [Apache License, Version 2.0](./LICENSE-APACHE) and
+- [MIT license](./LICENSE-MIT)
+
| Name/Alias | Contact (Email or GitHub) | Agreement to License |
| --------------- | ------------------------- | -------------------- |
| Alexander Weiss | @aawsome | Yes |
From 8140f5fae06659ae5c6557f181c37525ea595001 Mon Sep 17 00:00:00 2001
From: simonsan <14062932+simonsan@users.noreply.github.com>
Date: Tue, 22 Aug 2023 02:34:01 +0200
Subject: [PATCH 23/26] chore: add security policy
Signed-off-by: simonsan <14062932+simonsan@users.noreply.github.com>
---
.github/SECURITY.md | 24 ++++++++++++++++++++++++
1 file changed, 24 insertions(+)
create mode 100644 .github/SECURITY.md
diff --git a/.github/SECURITY.md b/.github/SECURITY.md
new file mode 100644
index 000000000..6079c7c0e
--- /dev/null
+++ b/.github/SECURITY.md
@@ -0,0 +1,24 @@
+# Security Policy
+
+## Supported Versions
+
+As long as `rustic` is not yet released, the latest commit on the `main` branch
+is supported for security updates.
+
+## Reporting a Vulnerability
+
+Responsible disclosure of security issues is highly appreciated.
+
+**Please do not report or discuss security vulnerabilities through public GitHub
+issues, discussions, or pull requests.**
+
+Issues can be reported privately to the maintainers by opening a
+[Security vulnerability report](https://github.com/rustic-rs/rustic/security/advisories/new).
+
+### Preferences
+
+- Please provide detailed reports with reproducible steps and a clearly defined
+ impact.
+- Include the version number of the vulnerable package in your report.
+- Fixes are most welcome. A private PR can be created from the security report
+ to work on and discuss the patch.
From 9ac819d8beb6bf9378fef61b0ad65ec8072fbbb4 Mon Sep 17 00:00:00 2001
From: simonsan <14062932+simonsan@users.noreply.github.com>
Date: Tue, 22 Aug 2023 02:58:35 +0200
Subject: [PATCH 24/26] chore: add security policy
Signed-off-by: simonsan <14062932+simonsan@users.noreply.github.com>
---
.github/SECURITY.md | 5 +++--
1 file changed, 3 insertions(+), 2 deletions(-)
diff --git a/.github/SECURITY.md b/.github/SECURITY.md
index 6079c7c0e..3ee44920e 100644
--- a/.github/SECURITY.md
+++ b/.github/SECURITY.md
@@ -2,8 +2,9 @@
## Supported Versions
-As long as `rustic` is not yet released, the latest commit on the `main` branch
-is supported for security updates.
+0.Y.Z versions are only supported for the last minor (`Y`) version.
+
+When `rustic` reaches 1.0.0, we will reiterate on this security policy.
## Reporting a Vulnerability
From 4fc17d3f4b0c70dd941e67a243c2f4dd19b5588b Mon Sep 17 00:00:00 2001
From: simonsan <14062932+simonsan@users.noreply.github.com>
Date: Tue, 22 Aug 2023 07:53:37 +0200
Subject: [PATCH 25/26] chore: add Github Releases to install-type
Signed-off-by: simonsan <14062932+simonsan@users.noreply.github.com>
---
.github/ISSUE_TEMPLATE/bug_report.yml | 1 +
1 file changed, 1 insertion(+)
diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml
index e3bdc2690..735e1673e 100644
--- a/.github/ISSUE_TEMPLATE/bug_report.yml
+++ b/.github/ISSUE_TEMPLATE/bug_report.yml
@@ -88,6 +88,7 @@ body:
multiple: false
options:
- Built from source
+ - Github Releases
- Binary from Package-management System
- Other (Please specify below)
default: 0
From 5d680dd05b5ea5f8961cbaee09112961ad3289ce Mon Sep 17 00:00:00 2001
From: simonsan <14062932+simonsan@users.noreply.github.com>
Date: Thu, 7 Sep 2023 23:22:57 +0200
Subject: [PATCH 26/26] add reference the the docs to issue template
Signed-off-by: simonsan <14062932+simonsan@users.noreply.github.com>
---
.github/ISSUE_TEMPLATE/bug_report.yml | 5 +++--
.github/PULL_REQUEST_TEMPLATE/pull_request_template.md | 3 ++-
2 files changed, 5 insertions(+), 3 deletions(-)
diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml
index 735e1673e..46317b389 100644
--- a/.github/ISSUE_TEMPLATE/bug_report.yml
+++ b/.github/ISSUE_TEMPLATE/bug_report.yml
@@ -231,8 +231,9 @@ body:
value: |
Please make sure, you have searched/tried the following resources before submitting this issue:
- * search [discussions](https://github.com/rustic-rs/rustic/discussions)
- * search [issue list (incl. closed issues)](https://github.com/rustic-rs/rustic/issues?q=is%3Aissue)
+ * search our [documentation](https://rustic.cli.rs/docs/)
+ * search our [discussions](https://github.com/rustic-rs/rustic/discussions)
+ * search the [issue list (incl. closed issues)](https://github.com/rustic-rs/rustic/issues?q=is%3Aissue)
* verify issue still exists in [rustic_beta (built from the main branch)](https://github.com/rustic-rs/rustic-beta)
- type: markdown
diff --git a/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md
index 30dfc468d..dba21e9d2 100644
--- a/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md
+++ b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md
@@ -23,4 +23,5 @@ contributions will be licensed under:
rights).
- [ ] I have added tests to cover my changes.
- [ ] All new and existing tests passed.
-- [ ] I have updated the documentation accordingly.
+- [ ] I have updated the internal and
+ [external documentation](https://github.com/rustic-rs/docs) accordingly.