diff --git a/CONTRIBUTING.md b/.github/CONTRIBUTING.md similarity index 97% rename from CONTRIBUTING.md rename to .github/CONTRIBUTING.md index c4321600..8f637ac5 100644 --- a/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -27,7 +27,7 @@ Currently, the only accepted inputs for this field are as follows: * `X-Mashape-Key` - _the name of the header which may need to be sent_ * `No` - _the API requires no authentication to run_ -Please continue to follow the alphabetical ordering that is in place per section. +Please continue to follow the alphabetical ordering that is in place per section. Each string in each section should be padded by one space on each side as well. If an API seems to fall into multiple categories, please place the listing within the section most in line with the services offered through the API. For example, the Instagram API is listed under `Social` since it is mainly a social network, even though it could also apply to `Photography`. diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md new file mode 100644 index 00000000..1bc7a3bb --- /dev/null +++ b/.github/ISSUE_TEMPLATE.md @@ -0,0 +1,4 @@ +Thanks for looking to open an issue for this project! + +If you are opening an issue to add a new entry, please consider opening a pull request instead! + diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 00000000..3d371125 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,9 @@ +Thank you for taking the time to work on a PR for this project! + +To ensure your PR is dealt with swiftly please check the following: + +- [ ] Your submissions are formatted according to the guidelines in the [contributing guide](CONTRIBUTING.md). + +- [ ] Your additions are ordered alphabetically. +- [ ] You have searched the repository for any relevant issues or PRs. +- [ ] Any category you are creating has the minimum requirement of 3 items. diff --git a/README.md b/README.md index 410a5cb4..827c2dd6 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ A collective list of free JSON APIs for use in web development. A JSON encoding of all entries can be found [here](json). -For information on contributing to this project, please see the [contributing guide](CONTRIBUTING.md). +For information on contributing to this project, please see the [contributing guide](.github/CONTRIBUTING.md). Please note a passing build status indicates all listed APIs are available since the last update. A failing build status indicates that 1 or more services may be unavailable at the moment. @@ -550,4 +550,4 @@ API | Description | Auth | HTTPS | Link | | OpenWeatherMap | Weather | `apiKey` | No | [Go!](http://openweathermap.org/api) | | Weatherbit | Weather | `apiKey` | Yes | [Go!](https://www.weatherbit.io/api) | | Wunderground | Weather | `apiKey` | Yes | [Go!](https://www.wunderground.com/weather/api/) | -| Yahoo! Weather | Weather | No | Yes | [Go!](https://developer.yahoo.com/weather/) | \ No newline at end of file +| Yahoo! Weather | Weather | No | Yes | [Go!](https://developer.yahoo.com/weather/) |