|
| 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 | Link | |
| 14 | +| --- | --- | --- | --- | |
| 15 | +| API Title | Description of API | Does this API require authentication? * | Link to API webpage | |
| 16 | + |
| 17 | +Example entry: |
| 18 | + |
| 19 | +``` |
| 20 | +| NASA | NASA data, including imagery | No | [Go!](https://api.nasa.gov) | |
| 21 | +``` |
| 22 | + |
| 23 | +Currently, the only accepted inputs for this 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 | +Please continue to follow the alphabetical ordering that is in place. |
| 31 | + |
| 32 | +##Pull Request |
| 33 | + |
| 34 | +After you've created a branch on your fork with your changes, it's time to [make a pull request][pr-link]! |
| 35 | + |
| 36 | +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. |
| 37 | + |
| 38 | +###Pull Request Pro Tips |
| 39 | + |
| 40 | +* [Fork][fork-link] the repository and [clone][clone-link] it locally. |
| 41 | +Connect your local repository to the original `upstream` repository by adding it as a [remote][remote-link]. |
| 42 | +Pull in changes from `upstream` often so that you stay up to date and so when you submit your pull request, |
| 43 | +merge conflicts will be less likely. See more detailed instructions [here][syncing-link]. |
| 44 | +* Create a [branch][branch-link] for your edits. |
| 45 | +* Contribute in the style of the project as outlined above. This makes it easier for the collaborators to merge |
| 46 | +and for others to understand and maintain in the future. |
| 47 | + |
| 48 | +###Open Pull Requests |
| 49 | + |
| 50 | +Once you’ve opened a pull request, a discussion will start around your proposed changes. |
| 51 | + |
| 52 | +Other contributors and users may chime in, but ultimately the decision is made by the collaborators. |
| 53 | + |
| 54 | +During the discussion, you may be asked to make some changes to your pull request. |
| 55 | + |
| 56 | +If so, add more commits to your branch and push them – they will automatically go into the existing pull request! |
| 57 | + |
| 58 | +[branch-link]: <http://guides.github.com/introduction/flow/> |
| 59 | +[clone-link]: <https://help.github.com/articles/cloning-a-repository/> |
| 60 | +[fork-link]: <http://guides.github.com/activities/forking/> |
| 61 | +[oauth-link]: <https://en.wikipedia.org/wiki/OAuth> |
| 62 | +[pr-link]: <https://help.github.com/articles/creating-a-pull-request/> |
| 63 | +[remote-link]: <https://help.github.com/articles/adding-a-remote/> |
| 64 | +[syncing-link]: <https://help.github.com/articles/syncing-a-fork> |
| 65 | + |
0 commit comments