diff --git a/.github/ISSUE_TEMPLATE/1-crash-report.yml b/.github/ISSUE_TEMPLATE/1-crash-report.yml index 66d7b002..97c92142 100644 --- a/.github/ISSUE_TEMPLATE/1-crash-report.yml +++ b/.github/ISSUE_TEMPLATE/1-crash-report.yml @@ -1,10 +1,11 @@ name: Report a Crash description: Tab Stash notified you about a crash, and you have the crash details. +labels: ["i-bug"] body: - type: markdown attributes: value: | - Thanks for taking the time to report a crash! + Sorry to hear you're having trouble, and thanks for taking the time to report a crash! If you're not sure whether you have one problem or multiple problems, it's better to err on the side of opening separate reports for each potential problem, since it's much easier to close duplicates than split a single issue into multiple issues. @@ -65,3 +66,15 @@ body: label: Additional Details description: | Any other context that might be helpful. + + - type: checkboxes + id: voting + attributes: + label: Voting + description: Please check the box below so GitHub will tell everyone how to vote for your issue—sorry, I know it's an unnecessary step, but that's the only way GitHub will allow me to include this message in the issue itself. + options: + - label: | + _Readers: If you are also experiencing this problem, please vote for it by giving the ORIGINAL POST a thumbs-up using the :smiley: button below. You are welcome to leave comments and discuss the issue if you have more details to add, but "Me too!" comments are not counted by the voting system._ + required: true + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/2-bug-report.md b/.github/ISSUE_TEMPLATE/2-bug-report.md deleted file mode 100644 index b6abad85..00000000 --- a/.github/ISSUE_TEMPLATE/2-bug-report.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -name: Report a Bug -about: You found a problem in Tab Stash, but you don't have any crash details. ---- - - - -### System Details - - - -- **OS Version:** [e.g. Windows 10, or Ubuntu 18.04] -- **Browser Version:** [e.g. Firefox 60.0.2] -- **Tab Stash Version:** [check the Tab Stash entry in `about:addons`] - -**Installed Browser Extensions:** - - - -- -- - -### Describe the Bug - - - -### Steps to Reproduce - - - -1. Go to '...' -2. Click on '....' -3. Scroll down to '....' -4. See error - -### Expected Behavior - - - -### Impact - - - -### Additional Details - - - - -
-Readers: If you are also experiencing this bug, please vote for it by giving the ORIGINAL POST a thumbs-up using the :smiley: button. You are welcome to leave comments and discuss the issue if you have more details to add, but "Me too!" comments are not counted by the voting system. diff --git a/.github/ISSUE_TEMPLATE/2-perf-report.yml b/.github/ISSUE_TEMPLATE/2-perf-report.yml new file mode 100644 index 00000000..82b889dd --- /dev/null +++ b/.github/ISSUE_TEMPLATE/2-perf-report.yml @@ -0,0 +1,126 @@ +name: Report a Performance Issue +description: Tab Stash froze, responded too slowly, or caused high CPU or memory usage. +labels: ["i-performance"] +body: + - type: markdown + attributes: + value: | + Sorry to hear you're having trouble, and thanks for taking the time to report a performance issue! + + If you're not sure whether you have one problem or multiple problems, it's better to err on the side of opening separate reports for each potential problem, since it's much easier to close duplicates than split a single issue into multiple issues. + + - type: input + id: os-version + attributes: + label: OS Version + description: Which operating system were you using when the problem happened? + placeholder: e.g. Windows 11, macOS 13, ... + validations: + required: true + + - type: input + id: browser-version + attributes: + label: Browser Version + description: What browser/browser version were you using when the problem happened? + placeholder: e.g. Firefox 104.0 + validations: + required: true + + - type: input + id: tab-stash-version + attributes: + label: Tab Stash Version + description: You can find the Tab Stash version number by scrolling down to the bottom of the UI. Or if the UI won't load, you can go to `about:addons`, click on "Tab Stash" and copy the version number from there. + validations: + required: true + + - type: input + id: open-tab-count + attributes: + label: Number of Open Tabs + description: How many open tabs do you have across all your browser windows? (Take your best guess; an exact count isn't required.) + validations: + required: true + + - type: input + id: stashed-bookmarks-count + attributes: + label: Number of Stashed Tabs + description: How many groups and tabs do you have in your stash? You can look at the search box in the Tab Stash UI for exact numbers, or take your best guess if you can't open the UI. + validations: + required: true + + - type: input + id: total-bookmark-count + attributes: + label: Total Number of Bookmarks + description: How many bookmarks do you have, **in total**? Take your best guess if you don't know the exact number. + validations: + required: true + + - type: input + id: performance-profile + attributes: + label: Performance Profile Link + description: If you have [collected a performance profile](https://github.com/josh-berry/tab-stash/wiki/Collect-a-Performance-Profile), please share the link here. (This is optional, but if your issue is particularly difficult to track down, having one would be helpful. You can also collect one later and put the link in a comment.) + validations: + required: false + + - type: textarea + id: installed-extensions + attributes: + label: Installed Extensions + description: List all other extensions you have installed. Also, please double-check to make sure you don't have any extensions installed which are [incompatible with Tab Stash](https://github.com/josh-berry/tab-stash/wiki/Known-Incompatibilities-with-Other-Extensions). + value: "- " + validations: + required: false + + - type: textarea + id: description + attributes: + label: Problem Description + description: Give a brief summary of the problem you're having. + validations: + required: true + + - type: textarea + id: actual-behavior + attributes: + label: Steps to Reproduce + description: As best you can, describe what you did to trigger the issue (if anything) and what *actually* happened. Be as specific and detailed as possible—the more detailed and concrete observations you provide, the better. Screenshots are welcome! + placeholder: | + 1. Go to ... + 2. Click on ... + 3. Tab Stash froze for a while + validations: + required: true + + - type: textarea + id: impact + attributes: + label: Impact + description: | + If you tried anything to work around or recover from the issue, or if the issue caused you additional problems, discuss it here. Again, be as concrete, specific and detailed as possible. For example, "searching locked up my whole computer and I had to restart everything" clearly illustrates the scale and scope of the problem. Whereas, "This is a huge problem and should be fixed ASAP" is likely to be ignored because it doesn't provide any detail about WHY the problem is huge. + validations: + required: false + + - type: textarea + id: details + attributes: + label: Additional Details + description: Include any other context or details that might be helpful. If possible, please share any error logs that you think might be relevant. [Here's how to collect them.](https://github.com/josh-berry/tab-stash/wiki/Collect-Error-Logs) + validations: + required: false + + - type: checkboxes + id: voting + attributes: + label: Voting + description: Please check the box below so GitHub will tell everyone how to vote for your issue—sorry, I know it's an unnecessary step, but that's the only way GitHub will allow me to include this message in the issue itself. + options: + - label: | + _Readers: If you are also experiencing this problem, please vote for it by giving the ORIGINAL POST a thumbs-up using the :smiley: button below. You are welcome to leave comments and discuss the issue if you have more details to add, but "Me too!" comments are not counted by the voting system._ + required: true + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/3-bug-report.yml b/.github/ISSUE_TEMPLATE/3-bug-report.yml new file mode 100644 index 00000000..602f8d84 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/3-bug-report.yml @@ -0,0 +1,107 @@ +name: Report Incorrect Behavior +description: An existing feature in Tab Stash caused a problem or didn't do what you expected. +labels: ["i-bug"] +body: + - type: markdown + attributes: + value: | + Sorry to hear you're having trouble, and thanks for taking the time to report a problem! + + If you're having a problem with freezing, slowness, CPU usage, RAM usage, etc., please [report a performance problem](https://github.com/josh-berry/tab-stash/issues/new?assignees=&labels=&projects=&template=2-perf-report.yml) instead. + + If you're expecting Tab Stash to do something it does not do today, please [request a feature](https://github.com/josh-berry/tab-stash/issues/new?assignees=&labels=&projects=&template=4-feature-request.yml) instead, even if you think this is missing functionality. + + If you're not sure whether you have one problem or multiple problems, it's better to err on the side of opening separate reports for each potential problem, since it's much easier to close duplicates than split a single issue into multiple issues. + + - type: input + id: os-version + attributes: + label: OS Version + description: Which operating system were you using when the problem happened? + placeholder: e.g. Windows 11, macOS 13, ... + validations: + required: true + + - type: input + id: browser-version + attributes: + label: Browser Version + description: What browser/browser version were you using when the problem happened? + placeholder: e.g. Firefox 104.0 + validations: + required: true + + - type: input + id: tab-stash-version + attributes: + label: Tab Stash Version + description: You can find the Tab Stash version number by scrolling down to the bottom of the UI. Or if the UI won't load, you can go to `about:addons`, click on "Tab Stash" and copy the version number from there. + validations: + required: true + + - type: textarea + id: installed-extensions + attributes: + label: Installed Extensions + description: List all other extensions you have installed. Also, please double-check to make sure you don't have any extensions installed which are [incompatible with Tab Stash](https://github.com/josh-berry/tab-stash/wiki/Known-Incompatibilities-with-Other-Extensions). + value: "- " + validations: + required: false + + - type: textarea + id: description + attributes: + label: Problem Description + description: Give a brief summary of the problem you're having. + validations: + required: true + + - type: textarea + id: actual-behavior + attributes: + label: Steps to Reproduce + description: As best you can, describe what you did to trigger the issue (if anything) and what *actually* happened. Be as specific and detailed as possible—the more detailed and concrete observations you provide, the better. Screenshots are welcome! + placeholder: | + 1. Go to ... + 2. Click on ... + 3. Tab Stash reports an error "..." + validations: + required: true + + - type: textarea + id: expected-behavior + attributes: + label: Expected Behavior + description: Describe what you *expected* to happen instead. Again, details are welcome! + placeholder: Instead of seeing an error, I expected Tab Stash to ... + validations: + required: true + + - type: textarea + id: impact + attributes: + label: Impact + description: | + If you tried anything to work around or recover from the issue, or if the issue caused you additional problems, discuss it here. Again, be as concrete, specific and detailed as possible. For example, "I spent an hour trying to restart the encabulator to retrieve my data after the crash" clearly illustrates the scale and scope of the problem. Whereas, "This is a huge problem and should be fixed ASAP" is likely to be ignored because it doesn't provide any detail about WHY the problem is huge. + validations: + required: false + + - type: textarea + id: details + attributes: + label: Additional Details + description: Include any other context or details that might be helpful. If possible, please share any error logs that you think might be relevant. [Here's how to collect them.](https://github.com/josh-berry/tab-stash/wiki/Collect-Error-Logs) + validations: + required: false + + - type: checkboxes + id: voting + attributes: + label: Voting + description: Please check the box below so GitHub will tell everyone how to vote for your issue—sorry, I know it's an unnecessary step, but that's the only way GitHub will allow me to include this message in the issue itself. + options: + - label: | + _Readers: If you are also experiencing this problem, please vote for it by giving the ORIGINAL POST a thumbs-up using the :smiley: button below. You are welcome to leave comments and discuss the issue if you have more details to add, but "Me too!" comments are not counted by the voting system._ + required: true + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/3-feature-request.md b/.github/ISSUE_TEMPLATE/3-feature-request.md deleted file mode 100644 index 7d2b707d..00000000 --- a/.github/ISSUE_TEMPLATE/3-feature-request.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -name: Request a Feature -about: Suggest an idea for improving Tab Stash. ---- - - - -### Problem Statement - - - -### Preferred Solution(s) - - - -### Alternative Solution(s) - - - -### Additional Context - - - - -
-Readers: If you are also interested in seeing this feature be developed, please vote for it by giving the ORIGINAL POST a thumbs-up using the :smiley: button. You are welcome to leave comments and discuss the feature request, but "Me too!" comments are not counted by the voting system. diff --git a/.github/ISSUE_TEMPLATE/4-feature-request.yml b/.github/ISSUE_TEMPLATE/4-feature-request.yml new file mode 100644 index 00000000..792d4ed7 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/4-feature-request.yml @@ -0,0 +1,57 @@ +name: Feature Request / Missing Functionality +description: You have an idea for improving Tab Stash, or you think something is missing that should be there. +labels: ["i-enhancement"] +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to suggest an improvement to Tab Stash! + + To keep things organized, please put only ONE feature per request. If you're not sure whether your idea would be one or multiple feature requests, it's better to err on the side of opening separate requests, since it's much easier to close duplicates than split a single request into multiple requests. + + - type: textarea + attributes: + id: problem-stmt + label: Problem Statement + description: | + What problem are you trying to solve that this feature could help with? Why is this feature important to you? Be as concrete, specific and detailed as possible. + + For example, "I have over 1,000,000 tabs stashed across 100,000 groups, and I can never find anything because scrolling takes a long time" clearly illustrates the scale and scope of the problem. Whereas, "Missing search feature is a huge problem" is likely to be ignored because it doesn't provide any detail about WHY the lack of a search feature is a huge problem. + validations: + required: true + + - type: textarea + attributes: + id: preferred-solution + label: Preferred Solution(s) + description: Describe your ideal solution. What is different from today? What would the solution look like? How would you use it to solve your problem? + validations: + required: true + + - type: textarea + attributes: + id: alt-solution + label: Alternative Solution(s) + description: Are there any other alternatives that would also solve your problem? What would those alternatives look like? + validations: + required: false + + - type: textarea + attributes: + id: details + label: Additional Context + description: Provide any other context/detail you think might be useful. + validations: + required: false + + - type: checkboxes + id: voting + attributes: + label: Voting + description: Please check the box below so GitHub will tell everyone how to vote for your issue—sorry, I know it's an unnecessary step, but that's the only way GitHub will allow me to include this message in the issue itself. + options: + - label: | + _Readers: If you are also interested in seeing this feature be developed, please vote for it by giving the ORIGINAL POST a thumbs-up using the :smiley: button below. You are welcome to leave comments and discuss the feature request, but "Me too!" comments are not counted by the voting system._ + required: true + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/4-question.md b/.github/ISSUE_TEMPLATE/4-question.md deleted file mode 100644 index e9aaa107..00000000 --- a/.github/ISSUE_TEMPLATE/4-question.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -name: Ask a Question -about: Use this if no other template seems to fit. ---- - -### Question - - - -### System Details - - - -- **OS Version:** [e.g. Windows 10, or Ubuntu 18.04] -- **Browser Version:** [e.g. Firefox 60.0.2] -- **Tab Stash Version:** [check the Tab Stash entry in `about:addons`] diff --git a/.github/ISSUE_TEMPLATE/5-question.yml b/.github/ISSUE_TEMPLATE/5-question.yml new file mode 100644 index 00000000..8522a4f0 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/5-question.yml @@ -0,0 +1,12 @@ +name: Ask a Question +description: Use this if no other template seems to fit. +labels: ["i-support request"] +body: + - type: textarea + attributes: + id: question + label: Question + description: | + Type your question here. The more context and detail you provide up-front, the easier it will be to respond quickly and accurately. + + [**PLEASE NOTE**: If you're using this form just to avoid having to answer the more detailed questions in the other forms, that won't work. I'm just going to ask you those questions anyway, and it'll drag the whole process out. You're not gonna upset me or anything, you can use this form if you want, I just thought you should know. :smiley:]