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

Add guidelines about including tokens in badge URLs (#5522)

Browse Source 
* Add guidelines about including tokens in badge URLs

* Tweak wording

Co-authored-by: Caleb Cartwright <calebcartwright@users.noreply.github.com>

Co-authored-by: Caleb Cartwright <calebcartwright@users.noreply.github.com>
This commit is contained in:
Pierre-Yves B
2020-09-13 09:08:32 +02:00
committed by GitHub
parent 932b3b56c5
commit 3eadcf448f
1 changed files with 3 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
CONTRIBUTING.md
View File

@@ -107,6 +107,9 @@ There are three places to get help:
- 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.
- Badges may require users to specify a token in the badge URL as long it is scoped only to
fetching information and doesn't expose any sensitive information. Generating a token with the
correct scope must be clearly documented.
## Badge URLs