Skip to content

Commit

Permalink
feat: issue forms (#859)
Browse files Browse the repository at this point in the history
* feat: issue forms
  • Loading branch information
seia-soto authored Sep 24, 2024
1 parent 9f85ef7 commit 0b615ae
Show file tree
Hide file tree
Showing 5 changed files with 249 additions and 76 deletions.
76 changes: 0 additions & 76 deletions .github/ISSUE_TEMPLATE/broken-page.md

This file was deleted.

8 changes: 8 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
blank_issues_enabled: true
contact_links:
- name: Contact Ghostery Support
url: https://www.ghostery.com/support
about: If you're unsure how to proceed, please feel free to reach out to our support channel, which is always available to assist you.
- name: Submit a new tracker
url: https://github.com/ghostery/trackerdb/issues/new/choose
about: If you'd like to submit a report to identify a tracker, please visit TrackerDB—our central source for tracker data and transparency.
148 changes: 148 additions & 0 deletions .github/ISSUE_TEMPLATE/general.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,148 @@
name: Report a broken page
description: Use this form to report any issues with a webpage, including instances where ads are not blocked or parts of the website fail to render or function properly.
labels: ["reproduction/required"]
body:
- type: dropdown
id: type
attributes:
label: What's happening?
multiple: true
options:
- ⛔️ type/ad-blocking
- Advertisement is visible
- Advertisement leftovers are visible
- Parts of the website fail to render
- Parts of the website do not function properly (incl. interactions)
- The website refreshes or navigates infinitely
- ⚠️ type/ad-wall
- Website asks ad-blocker uninstallment or disablement
- Website detects ad-blocker
- 🕸️ type/annoyance
- Annoying elements are visible
- ❌ never-consent/unsupported
- Consent popup is visible
- Consent popup is randomly handled
- 🛠️ never-consent/broken-interaction
- Page is dimmed or unresponsive (incl. scrolling and text selection)
- Consent popup is partially handled
- None of the above
validations:
required: true

- type: textarea
attributes:
label: Problematic URL(s).
description: |
Please provide the URL(s) where the issue occurs, as this information is essential for us to identify and resolve the problem.
placeholder: |
https://domain.tld
render: yaml
validations:
required: true

- type: textarea
attributes:
label: Description
description: |
A concise description of what you're experiencing and how to reproduce.
validations:
required: true

- type: textarea
attributes:
label: Other extensions used with Ghostery
description: |
Please list any other browser extensions you are using alongside Ghostery.
While we will do our best to identify the issue, certain complex interactions across multiple browser extensions may require further investigation.
render: yaml

- type: textarea
attributes:
label: Screenshot(s)
description: |
Screenshots provide valuable insights for our team in identifying the exact issue. If possible, kindly include a screenshot to assist in our investigation.
Please note that any files uploaded to GitHub are publicly accessible without requiring permission or authentication: see https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/attaching-files
value: |
<details>
<summary>Screenshot(s)</summary>
<!-- PUT YOUR SCREENSHOTS BELOW -->
<!-- END OF SCREENSHOTS -->
</details>
- type: input
attributes:
label: Version
description: |
Which version of our product are you currently using?
If the issue affects multiple versions, please specify the most recent version where the problem occurs or the range of affected versions.
Please open the extension popup from your browser, then click the menu button (three horizontal lines) in the top-right corner to access the "Privacy Protection" settings.
You can find the extension version at the bottom of the page.
If you're unable to determine the version but believe you have the latest one, you can find the most recent version at https://github.com/ghostery/ghostery-extension/releases/latest.
- type: dropdown
id: browsers
attributes:
label: Browser(s)
description: |
If you do not select an option from the dropdown below, we will assume the issue occurs across all browsers.
multiple: true
options:
- Ghostery Private Browser
- Firefox (incl. variants)
- Chrome (incl. Chromium variants)
- Safari
- Microsoft Edge
- Opera
- Other

- type: input
attributes:
label: Browser version(s)
description: |
Although it's uncommon, issues may arise with specific combination of browser and operating system.
Please, also specify the browser name if you selected "Other" in the dropdown above.
- type: input
attributes:
label: Geolocation
description: |
We kindly request that you provide an approximate location of your internet connection, as some services may restrict our access based on location.
We don't need a precise location—just the name of your country or continent will suffice.
- type: textarea
attributes:
label: Regional filters
description: |
If you have any regional filters enabled, please list them here.
If no filters are specified, we will assume all regional filters are enabled and proceed accordingly.
render: yaml

- type: textarea
attributes:
label: Custom filters
description: |
If you have any custom filters applied, please list them here.
If you have custom filters applied that are not listed, we may have difficulty reproducing the problem.
render: adblock

- type: checkboxes
attributes:
label: Your privacy
description: |
By submitting this issue, you confirm that no personal information is included in any of the fields.
If you're unsure whether your responses contain any personal information, we recommend [contacting our support channel to submit the issue](https://www.ghostery.com/support) instead.
If personal information is found in the submission, we can assist with its removal, but please note that we cannot take responsibility for any data leaks.
options:
- label: I confirm that this issue does not contain any personal information and understand that Ghostery is not responsible for the issue content.
required: true

- type: checkboxes
id: checks
attributes:
label: Additional checks
description: |
The checkboxes below will help us better categorize and attribute this issue.
options:
- label: '**IMPORTANT** Please check this box if your submission contains any adult or NSFW content. Additionally, prefix the issue title with "[NSFW]" to alert others that the content may be sensitive.'
- label: 'I have a Zendesk ticket number. Please **refrain from sharing your ticket number** in public forums, as it helps us identify your case and personal details.'
64 changes: 64 additions & 0 deletions .github/advanced-issue-labeler.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
policy:
- section:
- id:
- type
block-list:
- None of the above
label:
- name: type/ad-blocking
keys:
- ⛔️ type/ad-blocking
- Advertisement is visible
- Advertisement leftovers are visible
- Parts of the website fail to render
- Parts of the website do not function properly (incl. interactions)
- The website refreshes or navigates infinitely
- name: type/ad-wall
keys:
- ⚠️ type/ad-wall
- Website asks ad-blocker uninstallment or disablement
- Website detects ad-blocker
- name: type/annoyance
keys:
- 🕸️ type/annoyance
- Annoying elements are visible
- name: never-consent/unsupported
keys:
- ❌ never-consent/unsupported
- Consent popup is visible
- Consent popup is randomly handled
- name: never-consent/broken-interaction
keys:
- 🛠️ never-consent/broken-interaction
- Page is dimmed or unresponsive (incl. scrolling and text selection)
- Consent popup is partially handled
- id:
- browsers
block-list:
- Other
label:
- name: browser/firefox
keys:
- Ghostery Private Browser
- Firefox (incl. variants)
- name: browser/chrome
keys:
- Chrome (incl. Chromium variants)
- name: browser/safari
keys:
- Safari
- name: browser/edge
keys:
- Microsoft Edge
- name: browser/opera
keys:
- Opera
- id:
- checks
label:
- name: nsfw
keys:
- '**IMPORTANT** Please check this box if your submission contains any adult or NSFW content. Additionally, prefix the issue title with "[NSFW]" to alert others that the content may be sensitive.'
- name: source/zendesk
keys:
- 'I have a Zendesk ticket number. Please **refrain from sharing your ticket number** in public forums, as it helps us identify your case and personal details.'
29 changes: 29 additions & 0 deletions .github/workflows/issue-labeler.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
name: Issue labeler
on:
issues:
types: [ opened ]

permissions:
contents: read

jobs:
label-component:
runs-on: ubuntu-latest

permissions:
issues: write

steps:
- uses: actions/checkout@v3

- name: Parse issue form
uses: stefanbuck/github-issue-parser@2d2ff50d4aae06ab58d26bf59468d98086605f11
id: issue-parser
with:
template-path: .github/ISSUE_TEMPLATE/general.yml

- name: Set labels
uses: redhat-plumbers-in-action/advanced-issue-labeler@d498805e5c7c0658e336948b3363480bcfd68da6
with:
issue-form: ${{ steps.issue-parser.outputs.jsonString }}
token: ${{ secrets.GITHUB_TOKEN }}

0 comments on commit 0b615ae

Please sign in to comment.