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

update contributing docs on url/query params (#4141)

Browse Source 
* doc: update contribitung docs on url/query params

* chore: minor doc tweaks
This commit is contained in:
Caleb Cartwright
2019-10-07 07:28:55 -05:00
committed by repo-ranger[bot]
parent b05f0e8d0b
commit e9860aefbc
1 changed files with 5 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
CONTRIBUTING.md
View File

@@ -105,12 +105,11 @@ There are three places to get help:
## Badge URLs
- The format of new badges should be of the form
`/SERVICE/NOUN/PARAMETERS/QUALIFIERS.format`. For instance,
`/gitter/room/nwjs/nw.js.svg`. The vendor is gitter, the
badge is for rooms, the parameter is nwjs/nw.js, and the format is svg.
- For services which require a hostname, the badge should be of the form
`/SERVICE/SCHEME/HOST/NOUN/PARAMETERS/QUALIFIERS.format`. For instance,
`/discourse/https/discourse.example.com/topics.svg`.
`/SERVICE/NOUN/PARAMETERS/QUALIFIERS`. For instance,
`/gitter/room/nwjs/nw.js`. The vendor is gitter, the
badge is for rooms, and the parameter is nwjs/nw.js.
- Services which require a url/hostname parameter should use a query parameter to accept that value. For instance,
`/discourse/topics?server=https://meta.discourse.org`.
## Coding guidelines