github/public-apis
1
Fork 0
mirror of https://github.com/public-apis/public-apis synced 2024-12-01 20:18:16 +01:00
Code Releases Activity

Merge pull request #1688 from marekdano/update-contributing-guide

Browse Source 
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
1 changed files with 2 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
CONTRIBUTING.md
View File

@ -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`
* 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][squash-link] outlines the squash process.
* Target your Pull Request to the `master` branch of the `public-apis`
@ -80,7 +81,7 @@ If so, add more commits to your branch and push them – they will automatically
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!*
*Thanks for being a part of this project, and we look forward to hearing from you soon!*
[branch-link]: <http://guides.github.com/introduction/flow/>
[clone-link]: <https://help.github.com/articles/cloning-a-repository/>