Create PULL_REQUEST_TEMPLATE.md

This commit is contained in:
Collin M. Barrett 2017-10-25 23:26:58 +00:00 committed by GitHub
parent 7cad3da151
commit be7b4c2173

33
.github/PULL_REQUEST_TEMPLATE.md vendored Normal file
View file

@ -0,0 +1,33 @@
<!-- The information below is for reference only, please delete it before submitting your PR. -->
### 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"
}
```