2016-12-12 05:28:20 +01:00
# Contributing to public-apis
> While the masses of pull requests and community involvement is appreciated, some pull requests have been specifically
opened to market company APIs that offer paid solutions. This API list is not a marketing tool, but a tool to help the
2016-12-12 11:35:05 +01:00
community build applications and use free, public APIs quickly and easily. Pull requests that are identified as marketing attempts will not be accepted.
>
> Thanks for understanding! :)
2016-12-12 05:28:20 +01:00
##Formatting
Current API entry format:
| API | Description | Auth | Link |
| --- | --- | --- | --- |
| API Title | Description of API | Does this API require authentication? * | Link to API webpage |
Example entry:
2016-12-12 11:25:19 +01:00
2016-12-12 05:28:20 +01:00
```
| NASA | NASA data, including imagery | No | [Go! ](https://api.nasa.gov ) |
```
2016-12-12 11:25:19 +01:00
Currently, the only accepted inputs for this field are as follows:
* `oAuth` - _the API supports oAuth_
* `apiKey` - _the API uses a private key string/token for authentication - try and use the correct parameter_
2016-12-12 18:23:56 +01:00
* `X-Mashape-Key` - _the name of the header which may need to be sent_
* `No` - _the API requires no authentication to run_
2016-12-12 05:28:20 +01:00
2016-12-12 18:23:56 +01:00
Please continue to follow the alphabetical ordering that is in place per section.
2016-12-12 11:36:30 +01:00
2016-12-12 05:28:20 +01:00
##Pull Request
After you've created a branch on your fork with your changes, it's time to [make a pull request][pr-link]!
2016-12-12 11:35:42 +01:00
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.
2016-12-12 05:28:20 +01:00
###Pull Request Pro Tips
* [Fork][fork-link] the repository and [clone][clone-link] it locally.
Connect your local repository to the original `upstream` repository by adding it as a [remote][remote-link].
Pull in changes from `upstream` often so that you stay up to date and so when you submit your pull request,
merge conflicts will be less likely. See more detailed instructions [here][syncing-link].
* Create a [branch][branch-link] for your edits.
* Contribute in the style of the project as outlined above. This makes it easier for the collaborators to merge
and for others to understand and maintain in the future.
###Open Pull Requests
Once you’ ve opened a pull request, a discussion will start around your proposed changes.
2016-12-12 11:35:42 +01:00
2016-12-12 05:28:20 +01:00
Other contributors and users may chime in, but ultimately the decision is made by the collaborators.
2016-12-12 11:35:42 +01:00
2016-12-12 05:28:20 +01:00
During the discussion, you may be asked to make some changes to your pull request.
2016-12-12 11:35:42 +01:00
2016-12-12 05:28:20 +01:00
If so, add more commits to your branch and push them – they will automatically go into the existing pull request!
2016-12-12 05:32:05 +01:00
[branch-link]: < http: / / guides . github . com / introduction / flow / >
2016-12-12 05:28:20 +01:00
[clone-link]: < https: / / help . github . com / articles / cloning-a-repository / >
[fork-link]: < http: / / guides . github . com / activities / forking / >
[oauth-link]: < https: / / en . wikipedia . org / wiki / OAuth >
[pr-link]: < https: / / help . github . com / articles / creating-a-pull-request / >
[remote-link]: < https: / / help . github . com / articles / adding-a-remote / >
2016-12-12 05:32:05 +01:00
[syncing-link]: < https: / / help . github . com / articles / syncing-a-fork >