From be7b4c21739d576bad8335956e9e6cc9abdcf1c1 Mon Sep 17 00:00:00 2001 From: "Collin M. Barrett" Date: Wed, 25 Oct 2017 23:26:58 +0000 Subject: [PATCH] Create PULL_REQUEST_TEMPLATE.md --- .github/PULL_REQUEST_TEMPLATE.md | 33 ++++++++++++++++++++++++++++++++ 1 file changed, 33 insertions(+) create mode 100644 .github/PULL_REQUEST_TEMPLATE.md diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 000000000..d12628346 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,33 @@ + + +### 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 prior to 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/ListSample.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" +} +```