Skip to content

Latest commit

 

History

History
95 lines (68 loc) · 5.5 KB

CONTRIBUTING.md

File metadata and controls

95 lines (68 loc) · 5.5 KB
Raw

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 community build applications and use free, public APIs quickly and easily. Pull requests that are identified as marketing attempts will not be accepted.

Please make sure the API you want to add has a full free access or at least a free tier before submitting.

Thanks for understanding! :)

Formatting

Current API entry format:

API Description Auth HTTPS CORS
API Title(Link to API documentation) Description of API Does this API require authentication? * Does the API support HTTPS? Does the API support CORS? *

Example entry:

| [NASA](https://api.nasa.gov) | NASA data, including imagery | No | Yes | Yes |

* Currently, the only accepted inputs for the Auth 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
  • X-Mashape-Key - the name of the header which may need to be sent
  • No - the API requires no authentication to run
  • User-Agent - the name of the header to be sent with requests to the API

* Currently, the only accepted inputs for the CORS field are as follows:

  • Yes - the API supports CORS
  • No - the API does not support CORS
  • Unknown - it is unknown if the API supports CORS

Without proper CORS configuration an API will only be usable server side.

After you've created a branch on your fork with your changes, it's time to make a pull request.

Please follow the guidelines given below while making a Pull Request to the Public APIs

Pull Request Guidelines

  • Continue to follow the alphabetical ordering that is in place per section.
  • Each table column should be padded with one space on either side.
  • The Description should not exceed 100 characters.
  • 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.
  • Add one link per Pull Request.
  • Make sure the PR title is in the format of Add Api-name API for e.g.: Add Blockchain API
  • Use a short descriptive commit message. for e.g.: ❌Update Readme.md ✔ Add Blockchain API to Cryptocurrency
  • Search previous Pull Requests or Issues before making a new one, as yours may be a duplicate.
  • Don't mention the TLD(Top Level Domain) in the name of the API. for e.g.: ❌Gmail.com ✔Gmail
  • Please make sure the API name does not end with API. for e.g.: ❌Gmail API ✔Gmail
  • Please make sure the API has proper documentation.
  • 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 outlines the squash process.
  • Target your Pull Request to the master branch of the public-apis

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.

Pull Request Pro Tips

  • Fork the repository and clone it locally. Connect your local repository to the original upstream repository by adding it as a remote. 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.
  • Create a branch 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.

Other contributors and users may chime in, but ultimately the decision is made by the collaborators.

During the discussion, you may be asked to make some changes to your pull request.

If so, add more commits to your branch and push them – they will automatically go into the existing pull request. But don't forget to squash them.

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.

Thanks for being a part of this project, and we look forward to hearing from you soon!