|
| 1 | +# Contributing to public-apis |
| 2 | + |
| 3 | +> While the masses of pull requests and community involvement is appreciated, some pull requests have been specifically |
| 4 | +opened to market company APIs that offer paid solutions. This API list is not a marketing tool, but a tool to help the |
| 5 | +community build applications and use free, public APIs quickly and easily. Pull requests that are identified as marketing attempts will not be accepted. |
| 6 | +> |
| 7 | +> Thanks for understanding! :) |
| 8 | +
|
| 9 | +## Formatting |
| 10 | + |
| 11 | +Current API entry format: |
| 12 | + |
| 13 | +| API | Description | Auth | HTTPS | CORS | |
| 14 | +| --- | --- | --- | --- | --- | |
| 15 | +| API Title(Link to API webpage) | Description of API | Does this API require authentication? * | Does the API support HTTPS? | Does the API support [CORS](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS)? * | |
| 16 | + |
| 17 | +Example entry: |
| 18 | + |
| 19 | +``` |
| 20 | +| [NASA](https://api.nasa.gov) | NASA data, including imagery | No | Yes | Yes | |
| 21 | +``` |
| 22 | + |
| 23 | +\* Currently, the only accepted inputs for the `Auth` field are as follows: |
| 24 | + |
| 25 | +* `OAuth` - _the API supports OAuth_ |
| 26 | +* `apiKey` - _the API uses a private key string/token for authentication - try and use the correct parameter_ |
| 27 | +* `X-Mashape-Key` - _the name of the header which may need to be sent_ |
| 28 | +* `No` - _the API requires no authentication to run_ |
| 29 | + |
| 30 | +\* Currently, the only accepted inputs for the `CORS` field are as follows: |
| 31 | + |
| 32 | +* `Yes` - _the API supports CORS_ |
| 33 | +* `No` - _the API does not support CORS_ |
| 34 | +* `Unknown` - _it is unknown if the API supports CORS_ |
| 35 | + |
| 36 | +Please continue to follow the alphabetical ordering that is in place per section. Each table column should be padded with one space on either side. |
| 37 | + |
| 38 | +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`. |
| 39 | + |
| 40 | +## Pull Request |
| 41 | + |
| 42 | +After you've created a branch on your fork with your changes, it's time to [make a pull request][pr-link]! |
| 43 | + |
| 44 | +Once you’ve submitted a pull request, the collaborators can review your proposed changes and decide whether or not to incorporate (pull in) your changes. |
| 45 | + |
| 46 | +### Pull Request Pro Tips |
| 47 | + |
| 48 | +* [Fork][fork-link] the repository and [clone][clone-link] it locally. |
| 49 | +Connect your local repository to the original `upstream` repository by adding it as a [remote][remote-link]. |
| 50 | +Pull in changes from `upstream` often so that you stay up to date and so when you submit your pull request, |
| 51 | +merge conflicts will be less likely. See more detailed instructions [here][syncing-link]. |
| 52 | +* Create a [branch][branch-link] for your edits. |
| 53 | +* Contribute in the style of the project as outlined above. This makes it easier for the collaborators to merge |
| 54 | +and for others to understand and maintain in the future. |
| 55 | +* Please make sure you squash all commits together before opening a pull request. If your pull request requires changes upon review, please be sure to squash all additional commits as well. [This wiki page][squash-link] outlines the squash process. |
| 56 | + |
| 57 | +### Open Pull Requests |
| 58 | + |
| 59 | +Once you’ve opened a pull request, a discussion will start around your proposed changes. |
| 60 | + |
| 61 | +Other contributors and users may chime in, but ultimately the decision is made by the collaborators. |
| 62 | + |
| 63 | +During the discussion, you may be asked to make some changes to your pull request. |
| 64 | + |
| 65 | +If so, add more commits to your branch and push them – they will automatically go into the existing pull request! |
| 66 | + |
| 67 | +Opening a pull request will trigger a Travis CI build to check the validity of all links in the project. After the build completes, **please ensure that the build has passed**. If the build did not pass, please view the Travis CI log and correct any errors that were found in your contribution. |
| 68 | + |
| 69 | +Thanks for being a part of this project, and we look forward to hearing from you soon! |
| 70 | + |
| 71 | +[branch-link]: <http://guides.github.com/introduction/flow/> |
| 72 | +[clone-link]: <https://help.github.com/articles/cloning-a-repository/> |
| 73 | +[fork-link]: <http://guides.github.com/activities/forking/> |
| 74 | +[oauth-link]: <https://en.wikipedia.org/wiki/OAuth> |
| 75 | +[pr-link]: <https://help.github.com/articles/creating-a-pull-request/> |
| 76 | +[remote-link]: <https://help.github.com/articles/configuring-a-remote-for-a-fork/> |
| 77 | +[syncing-link]: <https://help.github.com/articles/syncing-a-fork> |
| 78 | +[squash-link]: <https://github.com/todotxt/todo.txt-android/wiki/Squash-All-Commits-Related-to-a-Single-Issue-into-a-Single-Commit> |
| 79 | + |
0 commit comments