Skip to content
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

Update templates to make mitigations faster and enable external users to report more easily #2137

Merged
merged 5 commits into from
Jun 12, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 13 additions & 17 deletions .github/ISSUE_TEMPLATE/breakage-form.yml
Original file line number Diff line number Diff line change
@@ -1,18 +1,17 @@
---
name: Breakage Form
description: Report breakage that requires a config mitigation
name: Site Breakage Form
description: Report a website issue on a DuckDuckGo app or browser extension
title: "Broken Site: "
body:
- type: markdown
attributes:
value: |
Each exception should be documented. Please create an issue using this form before creating a new exception. The exception should then link back to the created issue.
Set the title to the domain of the broken site.
Thanks for reporting a broken site! Please add the domain you're reporting to the title of this issue above.
- type: textarea
id: urls
attributes:
label: URLs affected
description: Which URLs are affected by this breakage?
description: On which URLs are you seeing the problem?
placeholder: https://example.com/page.html?product=shoes
validations:
required: true
Expand All @@ -24,16 +23,6 @@ body:
placeholder: Page is blank for 5s after loading
validations:
required: true
- type: textarea
id: breaking-requests
attributes:
label: Tracker Requests breaking the site
description: Requests that must be unblocked for the site to function
placeholder: |
1. https://example.com/script.js
2. …
validations:
required: true
- type: checkboxes
id: affected-platforms
attributes:
Expand All @@ -45,11 +34,13 @@ body:
- label: iOS Browser
- label: macOS Browser
- label: Windows Browser
validations:
required: true
- type: textarea
id: other
attributes:
label: Other Details
description: Any other information that may be useful
description: Any other information that might help us to investigate and fix your reported site?
- type: markdown
attributes:
value: |
Expand All @@ -58,10 +49,13 @@ body:
id: disable-privacy-protection
attributes:
label: Tested without Privacy Protections
description: Does the site work if Privacy Protection is disabled?
description: Does the site work if Privacy Protections are turned off?
options:
- "Yes"
- "No"
- "I don't know what this means"
validations:
required: true
- type: dropdown
id: verified-on-other-browsers
attributes:
Expand All @@ -70,3 +64,5 @@ body:
options:
- "Yes"
- "No"
validations:
required: true
4 changes: 3 additions & 1 deletion .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,9 @@
**Asana Task/Github Issue:**

## Description

<!--
If this is a SITE BREAKAGE MITIGATION, please include a BRIEF EXPLANATION that covers the REPORTED URL, the PLATFORMS AFFECTED, and the TRACKER(S) being unblocked or FEATURE being disabled, as well as a mention of the PROBLEM(S) users are experiencing. Please also check that you have referenced the URL of this PR as the "reason" value for the exception (where applicable).
-->

#### Reference
- [Config Reviewer Documentation](https://app.asana.com/0/1200890834746050/1204443212791216/f)
Expand Down
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,8 @@ If you'd like to license the source for commercial use, [please reach out](https

## Questions

- **Where can I find out why a particular exception has been added?** We mostly do two kinds of mitigations -- either allowing [certain trackers](https://github.com/duckduckgo/privacy-configuration/tree/main/features/tracker-allowlist.json) or disabling one or more [protections](https://github.com/duckduckgo/privacy-configuration/tree/main/features) on specific URLs or on certain [platforms](https://github.com/duckduckgo/privacy-configuration/tree/main/overrides). If you search in Code for the domain you're interested in, in most cases there will be a `"reason"` key below the exception for it with the URL of either an issue (old process) or a pull request (current process). Within the description of that linked URL we explain why we've added a breakage mitigation to the site in question and exactly what we're allowing or disabling to improve users' experience on the page.

- **Why do some exceptions have more documentation than others?** A review of
existing systems is ongoing to make this repository the central location for
exceptions and bring documentation and mitigations up-to-date.
Expand Down
Loading