1
mirror of https://github.com/public-apis/public-apis synced 2025-04-04 01:35:28 +02:00

Merge pull request from marekdano/update-contributing-guide

Update CONTIRBUTING.md file with removing API string from the API name.
This commit is contained in:
Marek Dano 2021-05-05 08:19:25 +01:00 committed by GitHub
commit ed1794c73d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

@ -52,6 +52,7 @@ After you've created a branch on your fork with your changes, it's time to [make
* Use a short descriptive commit message. *for e.g.*: ❌`Update Readme.md``Add Blockchain API to Cryptocurrency` * 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. * 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 * 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 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][squash-link] outlines the squash process. * 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.
* Target your Pull Request to the `master` branch of the `public-apis` * Target your Pull Request to the `master` branch of the `public-apis`