diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index c35846f2..00000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -name: Bug report -about: Create a report to help us improve KeeWeb -title: '' -labels: 'bug' -assignees: '' - ---- - -**Describe the bug** -A clear and concise description of what the bug is. - -**To Reproduce** -Steps to reproduce the behavior: -1. Go to '...' -2. Click on '....' -3. Scroll down to '....' -4. See error - -**Expected behavior** -A clear and concise description of what you expected to happen. - -**Screenshots** -If applicable, add screenshots to help explain your problem. - -**Environment** -Please copy all version information from Settings/Help - -**Kdbx File** -Does it happen on Demo or New database? -If you have a test db without your personal data, please attach it. - -**Logs** -Please open dev tools in your browser and attach output log from Console tab. If you are using a desktop app, devtools can be opened from Settings/General/Advanced. diff --git a/.github/ISSUE_TEMPLATE/bug_report.yaml b/.github/ISSUE_TEMPLATE/bug_report.yaml new file mode 100644 index 00000000..7c943216 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yaml @@ -0,0 +1,169 @@ +name: "🐛 Bug Report" +description: Create a report to help us improve KeeWeb! +title: "🐛 Bug: " +labels: [ + "Type ◦ Bug" +] +body: + - type: markdown + attributes: + value: | + 1. Please speak `English`. + 2. Make sure you are using the latest version and take a moment to check that your issue hasn't been reported before. + 3. It's really important to provide pertinent details and logs, + incomplete details will be handled as an invalid report. + + <br /> + + - type: dropdown + id: priority-type + attributes: + label: Priority + description: | + How critical is the issue? + Do not abuse this. Issues that completely break KeeWeb would be classified as critical. + If you are requesting a new feature, then it would be low or normal. + options: + - "Low" + - "Normal" + - "High" + - "Urgent" + validations: + required: true + + - type: input + id: ver-keeweb + attributes: + label: "Version: KeeWeb" + description: | + Version of KeeWeb you are running + Version is located in Settings › Help › App Information + placeholder: "Ex: v1.18.7" + validations: + required: true + + - type: dropdown + id: build-env + attributes: + label: Environment + description: | + What environment are you running KeeWeb as? + options: + - "Web" + - "Desktop" + + - type: dropdown + id: build-os + attributes: + label: Operating System + description: | + Select which OS you are running: + options: + - "Windows" + - "Mac" + - "Linux" + + - type: dropdown + id: issue-target + attributes: + label: Range of issue + description: | + Where does this issue occur? + Before submitting your bug report, try to see if the issue also occurs on the official demo site at https://app.keeweb.info/ + options: + - "The issue occurs on my own setup AND demo site" + - "The issue only occurs on my own setup, demo site works correctly" + + - type: dropdown + id: issue-db-type + attributes: + label: Database Type + description: | + What type of database are you having this issue with? + options: + - "Issue occurs only on new databases" + - "Issue occurs only on existing databases" + - "Issue occurs on both new and existing databases" + + - type: textarea + id: logs-env + attributes: + label: Environment Copy/Paste + description: | + Copy all information from Settings › Help inside KeeWeb + render: shell + + - type: textarea + id: description + attributes: + label: Description + description: | + Please provide a description of your issue here. + validations: + required: true + + - type: textarea + id: steps-reproduce + attributes: + label: Steps To Reproduce + description: | + Describe the steps that need taken by the developer(s) to get the error / issue you're experiencing. + value: | + - + - + - + - + validations: + required: true + + - type: textarea + id: expected-behavior + attributes: + label: Expected Behavior + description: | + Describe what you expect KeeWeb to actually do if it were working properly + value: | + - + - + - + - + validations: + required: true + + - type: textarea + id: logs-console + attributes: + label: Logs + description: | + List any error messages you received in the developer console. + Developer console for **web** can be opened with **SHIFT + CTRL + I** + Open **dev tools** in your browser and attach output log from **CONSOLE** tab. If you are using a desktop app, devtools can be opened from Settings › General › Advanced. + render: shell + + - type: textarea + id: references + attributes: + label: Referenced Issues + description: | + List any existing issues this ticket may be associated with. + Structure each issue as: + - #NUMBER + - #3 + value: | + - # + + - type: textarea + id: attachment-db + attributes: + label: "Attachments: Database kdbx File" + description: | + Attach a test database below that does give you the described issue. + Ensure it has no real security information within it as it will be publicly visible to all. + + - type: textarea + id: attachment-screenshots + attributes: + label: "Attachments: Screenshots" + description: | + Please provide screenshots of any errors or the issue you're having. + Gifs are even better. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index 36014cde..00000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -name: Feature request -about: Suggest an idea for this project -title: '' -labels: 'enhancement' -assignees: '' - ---- - -**Is your feature request related to a problem? Please describe.** -A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] - -**Describe the solution you'd like** -A clear and concise description of what you want to happen. - -**Describe alternatives you've considered** -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. diff --git a/.github/ISSUE_TEMPLATE/feature_request.yaml b/.github/ISSUE_TEMPLATE/feature_request.yaml new file mode 100644 index 00000000..4a97aa70 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yaml @@ -0,0 +1,45 @@ +name: "💡 Feature Request" +description: Got a suggestion? Submit your request here. +title: "💡 Feature: <title>" +labels: [ + "Type ◦ Feature" +] +body: + - type: markdown + attributes: + value: | + 1. Please speak English. + 2. Please take a moment to check that your feature hasn't already been suggested. + 3. Be detailed but to the point. + + - type: textarea + id: text-description + attributes: + label: Feature Description + description: | + Explain your feature. Be detailed. + If your feature addresses a problem; explain the problem. + placeholder: | + I would like to request ... + validations: + required: true + + - type: textarea + id: text-alternatives + attributes: + label: Alternatives Considered + description: | + A clear and concise description of any alternative solutions or features you've considered. + validations: + required: false + + - type: textarea + id: attachment-screenshots + attributes: + label: "Attachments: Screenshots" + description: | + If possible, provide screenshots. + Want a feature placed in a specific location? Mark it in a screenshot. + Want something modified? Try creating a mockup. + The more details about how it should look, the better. + Not required, but appreciated.