From 17cd905315bb221dfac624a43db56e4b01b81743 Mon Sep 17 00:00:00 2001 From: Maria Giganova Date: Thu, 16 May 2024 13:50:48 +0300 Subject: [PATCH] =?UTF-8?q?Pull=20request=20#1733:=20=F0=9F=93=9C=20Docs:?= =?UTF-8?q?=20update=20templates,=20add=20badge=20for=20mozilla=20in=20rea?= =?UTF-8?q?dme?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Merge in EXTENSIONS/browser-extension from feature/template_update to master Squashed commit of the following: commit 9ee7a1ec2e0166aa2b172313badc628e808a7db7 Author: Maria Giganova Date: Wed May 15 18:52:05 2024 +0300 📜 Docs: fix typos commit 7e86dde27f183e1362e2112686e4d32ccdb9557a Author: Maria Giganova Date: Wed May 15 17:55:04 2024 +0300 📜 Docs: fix link commit 98122a40e625ef172c7e71dd3e214806a7360f78 Author: Maria Giganova Date: Wed May 15 14:54:12 2024 +0300 📜 Docs: update templates, add badge for mozilla in readme --- .../{Bug_report.yml => 01-bug-report.yaml} | 241 ++++++++++++------ ...re_request.yml => 02-feature-request.yaml} | 13 +- .github/ISSUE_TEMPLATE/03-question.yaml | 25 ++ .github/ISSUE_TEMPLATE/config.yml | 12 + README.md | 3 + 5 files changed, 216 insertions(+), 78 deletions(-) rename .github/ISSUE_TEMPLATE/{Bug_report.yml => 01-bug-report.yaml} (60%) rename .github/ISSUE_TEMPLATE/{Feature_request.yml => 02-feature-request.yaml} (75%) create mode 100644 .github/ISSUE_TEMPLATE/03-question.yaml create mode 100644 .github/ISSUE_TEMPLATE/config.yml diff --git a/.github/ISSUE_TEMPLATE/Bug_report.yml b/.github/ISSUE_TEMPLATE/01-bug-report.yaml similarity index 60% rename from .github/ISSUE_TEMPLATE/Bug_report.yml rename to .github/ISSUE_TEMPLATE/01-bug-report.yaml index 80c285d421..ebf3c43a37 100644 --- a/.github/ISSUE_TEMPLATE/Bug_report.yml +++ b/.github/ISSUE_TEMPLATE/01-bug-report.yaml @@ -1,19 +1,28 @@ --- name: 🐞 Bug report -description: Create a bug report to help us improve AdGuard Browser Extension. +description: If you found something that we should know about. labels: [Bug] body: - type: markdown attributes: - value: | - Thanks for taking the time to fill out this bug report! + value: Thanks for taking the time to fill out this bug report! + - type: checkboxes + attributes: + label: Please answer the following questions for yourself before submitting an issue + options: + - label: Filters were updated before reproducing an issue + required: true + - label: I checked the [knowledge base](https://adguard.com/kb/) and found no answer + required: true + - label: I checked to make sure that this issue has not already been filed + required: true - type: input id: app_version attributes: label: AdGuard Extension version description: What version of our extension are you running? - placeholder: For example, 4.1.22 beta + placeholder: For example, 4.3.46 beta validations: required: true - type: input @@ -21,7 +30,7 @@ body: attributes: label: Browser version description: What browser do you use? - placeholder: For example, Chrome 106 + placeholder: For example, Chrome 123 validations: required: true - type: input @@ -29,46 +38,128 @@ body: attributes: label: OS version description: What operating system do you use? - placeholder: For example, macOS 12.4 + placeholder: For example, macOS 14.5 validations: required: true - - type: dropdown - id: filters + - type: markdown attributes: - label: What filters do you have enabled? - description: | - Select enabled filters from the list if they are related to the extension bug. + value: "### What filters do you have enabled?" + + - type: markdown + attributes: + value: | + Select enabled filters if they are related to the application bug. If the issue is related to the filtering (missed ads, cookie, etc.) - use the [Web Reporting Tool](https://kb.adguard.com/en/technical-support/reporting-tool) please. + use the [Web Reporting Tool](https://kb.adguard.com/technical-support/reporting-tool) please. + + - type: dropdown + id: filters_adblock + attributes: + label: Ad Blocking multiple: true options: - - No filters - AdGuard Base filter - AdGuard Mobile Ads filter - - AdGuard Chinese filter - - AdGuard Dutch filter - - AdGuard French filter - - AdGuard German filter - - AdGuard Japanese filter - - AdGuard Russian filter - - AdGuard Spanish/Portuguese filter - - AdGuard Turkish filter + - EasyList + validations: + required: false + + - type: dropdown + id: filters_privacy + attributes: + label: Privacy + multiple: true + options: - AdGuard Tracking Protection filter - AdGuard URL Tracking filter + - EasyPrivacy + - Legitimate URL Shortener + - Peter Lowe's Blocklist + - Fanboy's Anti-Facebook List + - Fanboy's Anti-thirdparty Fonts + validations: + required: false + + - type: dropdown + id: filters_social + attributes: + label: Social + multiple: true + options: - AdGuard Social Media filter + - Fanboy's Social Blocking List + validations: + required: false + + - type: dropdown + id: filters_annoyances + attributes: + label: Annoyances + multiple: true + options: - AdGuard Annoyances filter - AdGuard Cookie Notices filter - AdGuard Popups filter - AdGuard Mobile App Banners filter - - AdGuard Widgets filter - AdGuard Other Annoyances filter + - AdGuard Widgets filter + - Adblock Warning Removal List + - Fanboy's Annoyances + - EasyList Cookie List + - Dandelion Sprout's Annoyances List + validations: + required: false + + - type: dropdown + id: filters_security + attributes: + label: Security + multiple: true + options: + - Online Malicious URL Blocklist + - Phishing URL Blocklist + - Scam Blocklist by DurableNapkin + - uBlock Origin – Badware risks + - NoCoin Filter List + validations: + required: false + + - type: dropdown + id: filters_other + attributes: + label: Other + multiple: true + options: + - Filter unblocking search ads and self-promotion + - Fanboy's Anti-thirdparty Fonts - AdGuard DNS filter - AdGuard Experimental filter - - Filter unblocking search ads and self-promotion - - ---Third-party filters--- - - EasyList + validations: + required: false + + - type: dropdown + id: filters_regional + attributes: + label: Language-specific + multiple: true + options: + - AdGuard Chinese filter + - AdGuard Dutch filter + - AdGuard French filter + - AdGuard German filter + - AdGuard Japanese filter + - AdGuard Russian filter + - AdGuard Spanish/Portuguese filter + - AdGuard Turkish filter + - AdGuard Ukrainian filter - ABPindo + - ABPVN List + - Adblock List for Finland + - AdBlockID - Bulgarian list + - CJX's Annoyances List + - Dandelion Sprout's Nordic Filters + - Dandelion Sprout's Serbo-Croatian List - EasyList China - EasyList Czech and Slovak - EasyList Dutch @@ -76,57 +167,36 @@ body: - EasyList Hebrew - EasyList Italy - EasyList Lithuania + - EasyList Polish + - EasyList Portuguese + - EasyList Spanish + - EasyList Thailand + - Estonian List + - Frellwit's Swedish Filter + - Greek AdBlock Filter + - Hungarian filter + - Icelandic ABP List + - IndianList + - KAD - Anti-Scam - Latvian List + - List-KR - Liste AR - Liste FR - - ROList - - EasyPrivacy - - Icelandic ABP List - - AdBlockID - - Greek AdBlock Filter - - Fanboy's Annoyances - - Fanboy's Social Blocking List - - Web Annoyances Ultralist - - Thai Ads Filters - - Hungarian filter - - Peter Lowe's Blocklist - - Xfiles - - Adblock Warning Removal List - - Online Malicious URL Blocklist - - RU AdList - Counters - - ABPVN List - - Fanboy's Enhanced Tracking List + - Macedonian adBlock Filters - Official Polish filters for AdBlock, uBlock Origin & AdGuard + - Persian Blocker + - Polish Annoyances Filters + - Polish Anti Adblock Filters + - Polish Anti-Annoying Special Supplement - Polish GDPR-Cookies Filters - - Estonian List - - CJX's Annoyances List - Polish Social Filters - - Fanboy's Anti-Facebook List - - List-KR - - xinggsf - - I don't care about cookies - - EasyList Spanish - - KAD - Anti-Scam - - Adblock List for Finland + - road-block light + - ROList - ROLIST2 - - Iranian filter - - road-block - - Polish Annoyances Filters - - Polish Anti Adblock Filters - - Fanboy's Anti-thirdparty Fonts - - EasyList Cookie List - - NoCoin Filter List - - Frellwit's Swedish Filter + - RU AdList - Counters + - Xfiles + - xinggsf - YousList - - AlleBlock - - EasyList Polish - - Polish Anti-Annoying Special Supplement - - Dandelion Sprout's Nordic Filters - - Dandelion Sprout's Annoyances List - - Legitimate URL Shortener - - Dandelion Sprout's Serbo-Croatian List - - IndianList - - Others validations: required: false - type: dropdown @@ -139,28 +209,43 @@ body: - Block trackers - Remove tracking parameters - Hide your search queries - - Send websites signals not to track you + - Ask websites not to track you - Self-destruction of third-party cookies - Self-destruction of first-party cookies - Hide Referrer from third parties - Remove X-Client-Data header - Disable WebRTC + - type: textarea id: what-happened attributes: label: Issue Details - description: What happened? - placeholder: Please include all relevant details about the issue you've experienced. + description: Please provide a set of steps to reproduce the issue. + placeholder: + value: | + Steps to reproduce: + 1. + 2. + 3. validations: - required: false + required: true + - type: textarea id: how_it_should_be attributes: label: Expected Behavior - description: placeholder: A clear and concise description of what you expected to happen. validations: required: false + + - type: textarea + id: how_it_is + attributes: + label: Actual Behavior + placeholder: A clear description of what happened instead. + validations: + required: true + - type: textarea id: screens attributes: @@ -171,18 +256,24 @@ body: Use `
` tag to hide screenshots under the spoiler. placeholder: If applicable add screenshots explaining your problem. value: | -
Screenshot 1: +
Screenshot 1
validations: required: false + - type: textarea id: additional attributes: label: Additional Information - description: placeholder: Add any other context about the problem here. validations: required: false + + - type: markdown + attributes: + value: | + --- + Upvote [important issues](https://github.com/AdguardTeam/AdguardBrowserExtension/issues?q=is%3Aissue+is%3Aopen+sort%3Areactions-%2B1-desc+) with a :+1: \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/Feature_request.yml b/.github/ISSUE_TEMPLATE/02-feature-request.yaml similarity index 75% rename from .github/ISSUE_TEMPLATE/Feature_request.yml rename to .github/ISSUE_TEMPLATE/02-feature-request.yaml index 08ec370b38..9aceb2e5c8 100644 --- a/.github/ISSUE_TEMPLATE/Feature_request.yml +++ b/.github/ISSUE_TEMPLATE/02-feature-request.yaml @@ -1,7 +1,7 @@ --- name: 🌱 Feature request -description: Create a feature request to help us improve AdGuard Browser Extension. +description: If you know how AdGuard Browser Extension can be improved. labels: ["Feature Request"] body: - type: markdown @@ -15,7 +15,8 @@ body: description: What happened? placeholder: Is your feature request related to a problem? Please add a clear and concise description of what the problem is. validations: - required: false + required: true + - type: textarea id: how_it_should_be attributes: @@ -23,7 +24,8 @@ body: description: placeholder: Describe the solution you'd like in a clear and concise manner. validations: - required: false + required: true + - type: textarea id: additional attributes: @@ -32,3 +34,8 @@ body: placeholder: A clear and concise description of any alternative solutions or features you've considered. validations: required: false + - type: markdown + attributes: + value: | + --- + Upvote [important issues](https://github.com/AdguardTeam/AdguardBrowserExtension/issues?q=is%3Aissue+is%3Aopen+sort%3Areactions-%2B1-desc+) with a :+1: diff --git a/.github/ISSUE_TEMPLATE/03-question.yaml b/.github/ISSUE_TEMPLATE/03-question.yaml new file mode 100644 index 0000000000..ee869741bd --- /dev/null +++ b/.github/ISSUE_TEMPLATE/03-question.yaml @@ -0,0 +1,25 @@ +name: ❓ Question +description: If the options above do not work for you. +labels: "Question" +body: + - type: markdown + attributes: + value: Thanks for taking the time to fill out this form! + + - type: checkboxes + attributes: + label: Please answer the following questions for yourself before submitting a question. + options: + - label: I am running the latest version + - label: I checked the [knowledge base](https://adguard.com/kb/) and found no answer + required: true + - label: I checked to make sure that this issue has not already been filed + required: true + + - type: textarea + id: question + attributes: + label: Ask a question + placeholder: If you want to know more about how the app works. + validations: + required: true \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000000..a9c57ac9b6 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,12 @@ +'blank_issues_enabled': true +'contact_links': + - 'about': > + Please report filtering issues, for example advertising filters + misfiring or safe browsing false positives, using the form on our + website + 'name': 'AdGuard filters issues' + 'url': 'https://link.adtidy.org/forward.html?action=report&from=github' + - 'about': > + Please check AdGuard Knowledgebase for more useful information about our products + 'name': 'Knowledgebase' + 'url': 'https://adguard.com/kb/' \ No newline at end of file diff --git a/README.md b/README.md index 27097e08c9..7bc70a3ffe 100644 --- a/README.md +++ b/README.md @@ -20,6 +20,9 @@ Latest release + + Mozilla Add-on Version +