ComputerSurge/shields
3
0
Fork 0
Code Pull Requests 1 Activity

add guidance about scraping and unofficial APIs (#5393)

Browse Source
This commit is contained in:
chris48s
2020-08-06 19:15:11 +01:00
committed by GitHub
parent 63a40ce1b1
commit 164e9ea737
1 changed files with 5 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
CONTRIBUTING.md
View File

@@ -98,11 +98,15 @@ There are three places to get help:
## Badge guidelines
- Shields.io hosts integrations for services which are primarily
used by developers or which are widely used by developers
used by developers or which are widely used by developers.
- The left-hand side of a badge should not advertise. It should be a lowercase _noun_
succinctly describing the meaning of the right-hand side.
- Except for badges using the `social` style, logos should be _turned off by
default_.
- Badges should not obtain data from undocumented or reverse-engineered API endpoints.
- Badges should not obtain data by scraping web pages - these are likely to break frequently.
Whereas API publishers are incentivised to maintain a stable platform for their users,
authors of web pages have no such incentive.
## Badge URLs