Skip to content

Update README and templates - #6228

Merged
pritulaziah merged 14 commits into
AdguardTeam:masterfrom
dotext:patch-1
Sep 30, 2026
Merged

pritulaziah merged 14 commits into
AdguardTeam:masterfrom
dotext:patch-1

Conversation

@dotext

@dotext dotext commented Sep 19, 2026 •

Copy link
Copy Markdown
Contributor

Changes

README.md

  • Rearrange layout to match other recent AG repos for consistency
  • Accidental >" typo resolved
  • Update Twitter to X
  • Remove visual bug with <a href showing space and underline after SVG image
  • Update reporting tool link to match same as config.yml (https://link.adtidy.org/forward.html?action=report&app=home&from=github)
  • Remove invalid "Our plans" link (section already removed)
  • Update translation KB article link
  • Minor revisions (typos, grammar, etc.) made

01-bug-report.yaml

  • Include AdGuard Mail Tracking Protection filter
  • Minor version numbering updates to keep it in line with recent releases
  • Update reporting tool link to match same as config.yml (https://link.adtidy.org/forward.html?action=report&app=home&from=github)
  • Minor revisions (typos, grammar, etc.) made

03-question.yaml

  • Add required answer for using the latest version

Context

I've noticed that the README.md files are not unified in layout, need updated links and to resolve a few visual issues. The GitHub templates for Issues were also with outdated filter lists and with minor opportunities for some tweaks to bring it up to date with recent releases and fix a few things here and there.

Since working with others on the other PRs for updating the README.md and template files, there are a few more things that should be applied to the templates for the sake of cohesion. These changes have already been applied to this existing PR, but PRs for this second revision have been made if already merged before these changes:

Also added further repos that could use the same update treatment:

Include AdGuard Mail Tracking Protection filter, resolve apostrophe formatting for yaml
Used same link to reporting tool as config.yml
Missing required entry for first checkbox
Accidental `>"` typo resolved
Update Twitter to X
Remove visual bug with `<a href`,
showing space and underline after SVG image
Update reporting tool link to match same as config.yml 
Remove invalid "Our plans" link
Minor revisions
@dotext dotext changed the title Update 01-bug-report.yaml Update yaml files Sep 19, 2026
Updated translation KB article link
Minor revisions
Minor revisions.
@dotext dotext changed the title Update yaml files Update README and templates Sep 19, 2026

@pritulaziah pritulaziah left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi! Thanks for the PR — looks good overall.

One suggestion: please keep the original straight apostrophes in the filter names (Peter Lowe's Blocklist, Fanboy's Anti-Facebook List, etc.) instead of replacing them with curly ones (’). These are the canonical filter names used in the app, in the filter lists, and in the Knowledge Base, so the straight apostrophe is the commonly accepted spelling everywhere. Changing them in the form makes the labels inconsistent with the actual filter names, and could break any future tooling that matches submitted values against them. Straight apostrophes are also perfectly valid in YAML, so there's no formatting issue to resolve.

Could you revert the apostrophe replacements in 01-bug-report.yaml? And since this PR is part of a series across the AG repos, please apply the same fix everywhere (AdguardForMac, AdGuardMiniForMac, AdguardForAndroid, AdguardForiOS, AdguardBrowserExtension, ContentBlocker, AdGuardHome) so the templates stay consistent.

@dotext

dotext commented Sep 26, 2026 •

Copy link
Copy Markdown
Contributor Author

Straight apostrophes are also perfectly valid in YAML, so there's no formatting issue to resolve.

Thank you for explaining this, I was misled by the GitHub Editor as it was displaying the filter names with the incorrect colour styling to indicate the apostrophe was going to do something to the name.

image

I will quickly revert those edits to the apostrophes now.


Edit: All done, fixed on all affected repos.

@dotext
dotext requested a review from pritulaziah September 26, 2026 12:23
@neshumov
neshumov removed the request for review from vozersky September 28, 2026 12:26
Comment thread .github/ISSUE_TEMPLATE/01-bug-report.yaml
@dotext
dotext requested a review from neshumov September 29, 2026 11:02
@pritulaziah
pritulaziah merged commit 8970665 into AdguardTeam:master Sep 30, 2026
@dotext
dotext deleted the patch-1 branch September 30, 2026 10:27
@dotext

dotext commented Sep 30, 2026

Copy link
Copy Markdown
Contributor Author

Thanks for working with me on this. Would anyone know the best way to get the other PRs approved and merged as well?

Copy link
Copy Markdown
Member

Thanks! I'll do my best to get the other PRs approved and merged as well — I'll try to bring them to the attention of the relevant teams. That said, I can't make any promises about the timing, since it depends on each team's review capacity.

@dotext

dotext commented Oct 2, 2026

Copy link
Copy Markdown
Contributor Author

That's really kind, thank you!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants