Browse Source

Merge pull request #448 from toddmotto/add-pr-template

Add Pull Request and Issue Template
pull/452/head
Dave Machado 6 years ago
committed by GitHub
parent
commit
4e2bd67967
4 changed files with 16 additions and 3 deletions
  1. +1
    -1
      .github/CONTRIBUTING.md
  2. +4
    -0
      .github/ISSUE_TEMPLATE.md
  3. +9
    -0
      .github/PULL_REQUEST_TEMPLATE.md
  4. +2
    -2
      README.md

CONTRIBUTING.md → .github/CONTRIBUTING.md View File

@@ -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`.


+ 4
- 0
.github/ISSUE_TEMPLATE.md View File

@@ -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!


+ 9
- 0
.github/PULL_REQUEST_TEMPLATE.md View File

@@ -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.

+ 2
- 2
README.md View File

@@ -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/) |
| Yahoo! Weather | Weather | No | Yes | [Go!](https://developer.yahoo.com/weather/) |

Loading…
Cancel
Save