Update CONTRIBUTING.md

This commit is contained in:
Imre Kristoffer Eilertsen 2019-08-06 18:11:51 +02:00 committed by Collin M. Barrett
parent cb49ba76c2
commit 9b70049cda

View file

@ -8,6 +8,11 @@ Check out the <a href="https://hub.filterlists.com">FilterLists Hub</a>, a place
To submit a new list or update data about an existing list, please submit a pull request to [data](https://github.com/collinbarrett/FilterLists/tree/master/data) in conjunction with the data model described [here](https://github.com/collinbarrett/FilterLists/wiki/Data-Model_sidebar). Alternatively, you can [open a new issue](https://github.com/collinbarrett/FilterLists/issues/new) providing information for all of the fields described in the [data model](https://github.com/collinbarrett/FilterLists/wiki/Data-Model_sidebar).
While we are generally very open and welcoming of any new or changed lists, a few condition apply (although loosely):
* Adding the smaller text files that make up one complete list, e.g. *[EasyList General Block Popup](https://raw.githubusercontent.com/easylist/easylist/master/easylist/easylist_general_block_popup.txt)*, is not usually done. We do however do it for the language files of *[ABP Anti-Circumvention Filter List](https://easylist-downloads.adblockplus.org/abp-filters-anti-cv.txt)*; but due to its often-changing entries, those files should have ≥5 entries that cover ≥3 sites at the time of addition.
* Since `CHEF-KOCH` has a registered history of behaving aggressively and unfairly towards other filterlist makers and the FilterLists.com community, a case to add any of his lists would have had to be very strong, and mass additions are out of the question.
## Adding or Updating Rules
FilterLists does not maintain any of these lists. It serves only as a discovery tool to direct users to lists that they may want to use. If you want to request addition, modification, or removal of a rule from a list, you will need to contact the maintainers of that list directly. FilterLists provides a variety of ways you can get in contact with the maintainers to do so.
@ -84,4 +89,4 @@ The Agent takes the following command line arguments:
### Debugging
1. Execute `docker container ls -a` to find the `CONTAINER ID` of the container in question.
2. Execute `docker logs [CONTAINER ID]` replacing `[CONTAINER ID]` with the hash from step 1 to view the logs from that container.
2. Execute `docker logs [CONTAINER ID]` replacing `[CONTAINER ID]` with the hash from step 1 to view the logs from that container.