Skip to content

Update README and templates - #3633

Closed
dotext wants to merge 1 commit into
AdguardTeam:masterfrom
dotext:patch-1
Closed

dotext wants to merge 1 commit into
AdguardTeam:masterfrom
dotext:patch-1

Conversation

@dotext

@dotext dotext commented Sep 19, 2026 •

Copy link
Copy Markdown
Contributor

Changes

README.md

  • Update website link to match other AG repos
  • 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)
  • Update translation KB article link
  • Minor revisions (typos, grammar, etc.) made

01-bug-report.yaml & 04-bug-report-mv3.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)
  • Updated filter lists on 01-bug-report to match what is currently available (including language-specific)
  • Added upvote message
  • Minor revisions (typos, grammar, etc.) made
  • Capitalisation fixes for all AG repo cohesion
  • General cleanup and improvements with spacing, including quality-of-life improvements when completing pre-filled text

02-feature-request.yaml

  • Added missing "Thanks" message at beginning
  • Capitalisation fixes for all AG repo cohesion
  • General cleanup and improvements with spacing

03-question.yaml

  • Add required answer for using the latest version
  • Add checkbox for checking the knowledge base to match other AG repos
  • Rename "app" to "extension"
  • General cleanup and improvements with spacing

config.yml

  • Update knowledgebase to "AdGuard Knowledge Base"

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:

Comment thread README.md
<a href="https://addons.mozilla.org/en-US/firefox/addon/adguard-adblocker/">
<img src="https://img.shields.io/amo/v/adguard-adblocker?labelColor=orange" alt="Mozilla Add-on Version" />
</a>
<a href="https://github.com/AdguardTeam/AdguardBrowserExtension/releases"><img src="https://img.shields.io/github/release/AdguardTeam/AdguardBrowserExtension/all.svg" alt="Latest release" /></a>

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.

undo formatting

@dotext dotext Oct 1, 2026 •

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

@105th, if I undo this formatting, the visual bug with <a href showing space and underline after SVG image will reappear. For some reason, having it on the single line resolves it, as seen in the now merged one in AdGuardforWindows.

Current:
Screenshot 2026-10-01 at 9 27 32 pm

Proposed:
image

@105th 105th 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.

a few leftovers from the link unification

Comment thread .github/ISSUE_TEMPLATE/04-bug-report-mv3.yaml Outdated
Comment thread .github/ISSUE_TEMPLATE/01-bug-report.yaml Outdated
Comment thread .github/ISSUE_TEMPLATE/04-bug-report-mv3.yaml Outdated
@dotext
dotext requested a review from 105th October 1, 2026 21:44
@dotext
dotext marked this pull request as draft October 7, 2026 19:30
@dotext
dotext marked this pull request as ready for review October 7, 2026 19:39
@dmitriivqa39

Copy link
Copy Markdown
Contributor

Hi @dotext
Thanks for PR. It will be availabale in the very next release.

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