From a65b775d562015cac0a1499fc734813fbfb12724 Mon Sep 17 00:00:00 2001 From: "Collin M. Barrett" Date: Wed, 1 Nov 2017 05:10:31 -0500 Subject: [PATCH] documentation update --- .github/CONTRIBUTING.md | 9 ------- .github/ISSUE_TEMPLATE.md | 35 +--------------------------- .github/PULL_REQUEST_TEMPLATE.md | 35 ---------------------------- .github/README.md | 40 ++++++++++++++++++++------------ 4 files changed, 26 insertions(+), 93 deletions(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 0cadcf38a..e69de29bb 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -1,9 +0,0 @@ -# How to Contribute to FilterLists - -## Submitting or Updating Lists - -We need contributors to help maintain this directory. Please submit [pull requests](https://github.com/collinbarrett/FilterLists/pulls) or [issues](https://github.com/collinbarrett/FilterLists/issues) providing new or updated list information to ensure we have the most up-to-date information. - -## Application Development - -This project has mostly been a one-man side project. I have been working on rebuilding an API and web app on .NET Core to provide a slew of enhanced features to FilterLists users. If you want to jump in and contribute to the application development, I would love to have you join! \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md index 837f1b2ba..47ca736eb 100644 --- a/.github/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE.md @@ -1,34 +1 @@ - - -FilterLists serves as a directory for interacting with various filter lists. We do not maintain any lists ourselves. If your issue is regarding a rule or other detail of a specific list, please contact the maintainer of that list directly. - -Before submitting a new issue, please review the checklist below. - -## General Issues: -* [ ] Have you verified that there are no related existing open issues that you would be duplicating? -* [ ] Have you provided enough relevant detail for others to understand and discuss your issue? - -## New or Updated Lists: - -* [ ] Have you considered submitting a [Pull Request](https://github.com/collinbarrett/FilterLists/pulls) directly to participate as a contributor? -* [ ] Have you provided all properties available for the list (see sample below)? -* [ ] Have you converted the list name to [title case](https://en.wikipedia.org/wiki/Letter_case#Title_case)? -* [ ] Have you ensured that all URLs are functioning properly? -* [ ] Have you ensured all URLs point to HTTPS if supported? - -## Properties -[Source](https://github.com/collinbarrett/FilterLists/blob/master/data/DataSample.json) | [Schema](https://github.com/collinbarrett/FilterLists/blob/master/data/DataSchema.json) - -| Property | Description | -| -------------- | ---------------------------------------- | -| 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 is available, a generic description should be composed by the FilterLists contributor. | -| descrSourceUrl | The URL to the list's documentation page from which the description was quoted if applicable. | -| 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. | -| email | The email address of the list's maintainer(s) if publicly available. | -| forumUrl | The URL to the list's forum where issues, change requests, etc. are discussed. | -| 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. | -| issuesUrl | The URL to the list's GitHub Issues. | -| list | The name of the list as stated by the list maintainer(s) in title case. | -| related | List names that are directly related to the list. For example, if a list is a combination of other lists, its master lists would be considered "related." Sorted alphabetically by convention. | -| tagLang | Array of ISO 639-1 language codes targeted by the list. | -| viewUrl | The URL to the list in raw text format. zip files and other formats are acceptable if no text format is available. | \ No newline at end of file +If you are submitting a suggestion for a new FilterList or an update to an exisiting FilterList, please provide all possible [properties](https://github.com/collinbarrett/FilterLists/blob/master/.github/README.md#user-content-properties) with your submission. \ No newline at end of file diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 16a794442..e69de29bb 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,35 +0,0 @@ - - -Before submitting a new pull request, please review the checklist below. - -## Closing Issues: -* [ ] Have you included "closes #XXXX" in your comment to auto-close the issue that your PR fixes? - -## General Submissions: -* [ ] Is there an issue open for this change? If not, please open a new issue before submitting this PR. - -## Submissions for New or Updated Lists: - -* [ ] Have you filled in all properties available for the list (see sample below)? -* [ ] Have you sorted the properties in alphabetical order? -* [ ] Have you converted the list name to [title case](https://en.wikipedia.org/wiki/Letter_case#Title_case)? -* [ ] Have you ensured that all URLs are functioning properly? -* [ ] Have you ensured all URLs point to HTTPS if supported? - -### Sample List JSON Object: -[Source](https://github.com/collinbarrett/FilterLists/blob/master/data/DataSample.json) | [Schema](https://github.com/collinbarrett/FilterLists/blob/master/data/DataSchema.json) - -``` -{ - "Author": "John Doe", - "Description": "A sample list to filter out advertisements.", - "DescriptionSourceUrl": "https://mysample.list", - "DonateUrl": "https://mysample.list/donate/", - "Email": "contact@mysample.list", - "ForumUrl": "https://mysample.list/forum/", - "HomeUrl": "https://mysample.list/", - "IssuesUrl": "https://github.com/mysamplelist/issues", - "Name": "My Sample List", - "ViewUrl": "https://mysample.list/list.txt" -} -``` \ No newline at end of file diff --git a/.github/README.md b/.github/README.md index 42c09cc56..7af8f4129 100644 --- a/.github/README.md +++ b/.github/README.md @@ -18,19 +18,29 @@ FilterLists is the independent and comprehensive directory of all public filter ## Development Notice (Updated July 13, 2017) FilterLists improvements are slow and tend to be in spurts. I care about this project as both a resource for the community and a learning tool for me. However, my day job comes first which often results in little to no work on the project at times. I happily welcome anyone that wants to contribute. The immediate projects are converting the data to an actual database (rather than a Google Sheet) and then exposing the data via a [.Net Core API](https://github.com/collinbarrett/FilterLists/projects/3). I would also love to build a more responsive front-end, but I am not a front-end developer and would welcome help on [this](https://github.com/collinbarrett/FilterLists/projects/4). -## Indexed Properties (Under Construction) -[Source](https://github.com/collinbarrett/FilterLists/blob/master/data/DataSample.json) | [Schema](https://github.com/collinbarrett/FilterLists/blob/master/data/DataSchema.json) +## Properties -| Property | Description | -| -------------- | ---------------------------------------- | -| 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 is available, a generic description should be composed by the FilterLists contributor. | -| descrSourceUrl | The URL to the list's documentation page from which the description was quoted if applicable. | -| 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. | -| email | The email address of the list's maintainer(s) if publicly available. | -| forumUrl | The URL to the list's forum where issues, change requests, etc. are discussed. | -| 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. | -| issuesUrl | The URL to the list's GitHub Issues. | -| list | The name of the list as stated by the list maintainer(s) in title case. | -| related | List names that are directly related to the list. For example, if a list is a combination of other lists, its master lists would be considered "related." Sorted alphabetically by convention. | -| tagLang | Array of ISO 639-1 language codes targeted by the list. | -| viewUrl | The URL to the list in raw text format. zip files and other formats are acceptable if no text format is available. | \ No newline at end of file +### Maintainers + +| Property | Description | +|---------------|--------------------------------------------| +| EmailAddress | The maintainer's email address | +| HomeUrl | The URL to the maintainer's home page | +| Name | The maintainer's name | +| TwitterHandle | The maintainer's twitter handle | +| *FilterLists | Collection of the maintainer's FilterLists | + +### FilterLists + +| Property | Description | +|----------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Description | 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 is available, a generic description should be composed by the FilterLists contributor. | +| DescriptionSourceUrl | The URL to the list's documentation page from which the description was quoted if applicable. | +| 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. | +| EmailAddress | | +| ForumUrl | The URL to the list's forum where issues, change requests, etc. are discussed. | +| 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. | +| IssuesUrl | The URL to the list's GitHub Issues. | +| Name | The name of the list as stated by the list maintainer(s) in title case. | +| SubmissionUrl | The URL to the list's contact form for suggesting new and updated filter rules. | +| ViewUrl | The URL to the list in raw text format. zip files and other formats are acceptable if no text format is available. | \ No newline at end of file