-
Notifications
You must be signed in to change notification settings - Fork 107
chore(meta): Create issue templates and PR template, add authors.md #835
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Draft
simonsan
wants to merge
39
commits into
main
Choose a base branch
from
simonsan-patch-1
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Changes from 8 commits
Commits
Show all changes
39 commits
Select commit
Hold shift + click to select a range
dd441a5
Create bug_report.md template
simonsan 257823b
meta(docs): add PR template and authors file
simonsan ac0de7f
chore: Implement bug_report template as Github form
simonsan 8ba7553
chore: fix issues with template
simonsan 9a43e33
fix headline
simonsan 0cb2038
fix headline
simonsan 88d05b8
fix smaller issues
simonsan aca3b04
add feature request template and refine issue template
simonsan d49a759
Merge branch 'main' into simonsan-patch-1
aawsome 2467b80
Merge branch 'main' into simonsan-patch-1
simonsan 2a04ee7
style: remove unneeded headlines
simonsan c2b3d32
style: remove unneeded headlines
simonsan 8d30e5a
style: use input for rustic_version for space reasons
simonsan 109759e
fix: try to fix md-links in checkboxes
simonsan 48cc34d
fix: try to fix md-links in checkboxes
simonsan 16743b2
try html in checkbox
simonsan 842d5de
move md-links into description
simonsan 8d3836c
move link to extra text
simonsan bdd5060
fix order
simonsan 03e0b35
put links below
simonsan 7da7555
newline in thank you not
simonsan 2cb623e
fix feature request
simonsan a5d0e10
fix lint and checklist item order
simonsan 6d3e598
Merge branch 'main' into simonsan-patch-1
simonsan 6f1a43c
docs: add more explicit license note
simonsan 8140f5f
chore: add security policy
simonsan 9ac819d
chore: add security policy
simonsan 9cd9d6d
Merge branch 'main' into simonsan-patch-1
simonsan 4fc17d3
chore: add Github Releases to install-type
simonsan 4063bc5
Merge branch 'main' into simonsan-patch-1
simonsan c20e3c3
Merge branch 'main' into simonsan-patch-1
simonsan 5d680dd
add reference the the docs to issue template
simonsan b97f7f8
Merge branch 'main' into simonsan-patch-1
simonsan d6fa042
Merge branch 'main' into simonsan-patch-1
simonsan cb243e3
Merge branch 'main' into simonsan-patch-1
simonsan 8f6cb7a
Merge branch 'main' into simonsan-patch-1
simonsan cfe5de3
Merge branch 'main' into simonsan-patch-1
simonsan eae38aa
Merge branch 'main' into simonsan-patch-1
simonsan f7509ad
Merge branch 'main' into simonsan-patch-1
simonsan File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,225 @@ | ||
| 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: textarea | ||
| 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: 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: | ||
| - **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: true | ||
|
|
||
| - 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: true | ||
|
|
||
| - 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: 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: | | ||
| ## Thanks for the report! We'll look into it as soon as possible. | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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. |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.