prehistoric-systems/FilterLists
1
0
Fork 0
mirror of https://github.com/collinbarrett/FilterLists.git synced 2026-03-11 09:04:27 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update ISSUE_TEMPLATE.md

Browse source
This commit is contained in:
Collin M. Barrett 2017-02-01 20:06:40 -06:00 committed by GitHub
parent 7fda9fd6f5
commit 8fcdd7a53c
1 changed files with 16 additions and 14 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

30
.github/ISSUE_TEMPLATE.md vendored
View file

@ -1,26 +1,28 @@
ProTip: Click "Preview" just above this field for easy-reading of the instructions.
# General Comments / Questions
If your issue is a general comment or question regarding FilterLists, feel free to delete all of this template comment and just type away. Please provide as much detail as is necessary.
If your issue is a general comment or question regarding FilterLists, feel free to delete all of this template content and just type away. Please provide as much detail as is necessary.
# List Updates / Additions
If your issue is related to adding a new list or updating an existing list, please create only one issue per list. When creating the issue, pick the applicable table below and replaced the italicized sample values with the list's information. Delete all of the other tables and template content for simplicity.
If your issue is related to adding a new list or updating an existing list, please create only one issue per list. When creating the issue, pick the applicable table below and replace the italicized sample values with the list's information. Delete all of the other tables and template content for simplicity.
## Global
| Property | Description | Value |
|---|---|---|
| list | The name of the list as stated by the list maintainer(s) in title case. | |
| descr | A brief description of the list's functionality. Preferably, this is quoted (if non-English, translate to English via translator or Google Translate for consistency) from the list's documentation or composed by a maintainer of the list. If neither are available, a generic description should be composed by the FilterLists contributer. | |
| descrSourceUrl | The URL to the list's documentation page from which the description was quoted if applicable. | |
| viewUrl | The URL to the list in raw text format. zip files and other formats are acceptable if no text format is available. | |
| homeUrl | The URL to the list's home page. Preferably, this is stated in the header of the list. Alternatively, it could be a custom domain, GitHub page, blog post, forum post, etc. that serves as a primary source of information for the list. | |
| guideUrl | The URL to the list's instruction guide if it is significantly different than the homeUrl. | |
| forumUrl | The URL to the list's forum where issues, change requests, etc. are discussed. | |
| issuesUrl | The URL to the list's GitHub Issues. | |
| email | The email address of the list's maintainer(s) if publicly available. | |
| changelogUrl | The URL to the list's changelog such as an RSS feed, GitHub commits log, Mercurial log, etc. | |
| donateUrl | The URL to the list's donation page. This could be a custom PayPal or similar link, or a link to a web page discussing various donation options. Pull requests that include changes to this link will undergo further verification to prevent fraud. | |
| forksCombos | List names that are either a fork or a combo of list. Sorted alphabetically by convention. | |
| list | The name of the list as stated by the list maintainer(s) in title case. | _Sample List_ |
| descr | A brief description of the list's functionality. Preferably, this is quoted (if non-English, translate to English via translator or Google Translate for consistency) from the list's documentation or composed by a maintainer of the list. If neither are available, a generic description should be composed by the FilterLists contributer. | _This list blocks ads._ |
| descrSourceUrl | The URL to the list's documentation page from which the description was quoted if applicable. | _https://samplelisthome.com_ |
| viewUrl | The URL to the list in raw text format. zip files and other formats are acceptable if no text format is available. | _https://samplelisthome.com/list.txt_ |
| homeUrl | The URL to the list's home page. Preferably, this is stated in the header of the list. Alternatively, it could be a custom domain, GitHub page, blog post, forum post, etc. that serves as a primary source of information for the list. | _https://samplelisthome.com_ |
| guideUrl | The URL to the list's instruction guide if it is significantly different than the homeUrl. | _https://samplelisthome.com/guide/_ |
| forumUrl | The URL to the list's forum where issues, change requests, etc. are discussed. | _https://samplelisthome.com/forum/_ |
| issuesUrl | The URL to the list's GitHub Issues. | _https://github.com/SampleList/issues_ |
| email | The email address of the list's maintainer(s) if publicly available. | _email@samplelist.com_ |
| changelogUrl | The URL to the list's changelog such as an RSS feed, GitHub commits log, Mercurial log, etc. | _https://samplelisthome.com/feed/_ |
| donateUrl | The URL to the list's donation page. This could be a custom PayPal or similar link, or a link to a web page discussing various donation options. Pull requests that include changes to this link will undergo further verification to prevent fraud. | _https://samplelisthome.com/donate/_ |
| forksCombos | List names that are either a fork or a combo of list. Sorted alphabetically by convention. | _Sample List Variant A_, _Sample List Variant B_ |
## Regional