Files
adfilt/.github/CONTRIBUTING.md
T

4.4 KiB

(Last updated: 30th of March 2023)

Notes on how to contribute:

Issues and thoughts can be reported in the Issues tab. If you're reporting about a filter issue, you are expected to either explain the issue in deep detail, or to track down the problematic filter entry on your own. You're also encouraged to write:

  • Which adblock lists are you using?
  • Which adblock extension are you using?

Pull requests can be done, but they should permit me to be able to edit them, just in case there's some excusable formatting errors in your pull request.

I will normally do the utmost to resolve problems to the best of my ability, but I reserve the right to declare a case to be closed if there's too much back and forth with no end in sight. And especially if the reporter isn't even using the list that (s)he is trying to make changes to.

Issues and problems will normally be tested for in the most recent development version of uBlock Origin. In rare cases where the problems are only visible in other extensions, I would also test with AdGuard, Adblock Plus, AdGuard Home, and/or the Windows system hosts file. For a list of supported, unsupported, and recommended adblockers, read this.

Nordic list submissions

When making a submission pull request to the Nordic list, make sure to do the edits to either:

All other versions are generated from those two files.

Communication languages

All communication and contribution that is permitted above, can also be done in Bokmål, Nynorsk, Swedish and Danish. In those cases, I would take contact with you in Bokmål, unless otherwise is requested.

Low-priority websites

I will refuse to write or double-check entries for the following sites, and any suggested entries or fixes for them will be added verbatim:

Version dates in pull requests

If possible, change the ! Version: date if you're making a pull request, into the date where the pull request is submitted to me. If the existing date is the same as the submission date, increase its v number by one instead.

Syntaxes

For entries that start with || or @@||, the following applies (Note the use of or absense of ^):

  • For normal domains like example.org: Write the domain as ||example.org^
  • For multi-TLD domains like example.*: Write the domain as ||example.
  • For entire TLDs like org: Write it as ||org^

Other

Should I have missed out on any details that'd be nice to have in this contribution explanation, give me a heads up about it, e.g. in Issues.

I do encourage forking, both for experimentation, archiving, or for any other reason you may come up with.

When submitting issue reports and pull requests, I aim to reply to it or fix it within 72 hours. Discussions threads where I see that input from me is desired, is aimed to be handled within 96 hours, although delays can happen. Commit-replies are not always read or replied to.