From e9860aefbcf2f7eca161d5c9dff83ef80fd4fbda Mon Sep 17 00:00:00 2001 From: Caleb Cartwright Date: Mon, 7 Oct 2019 07:28:55 -0500 Subject: [PATCH] update contributing docs on url/query params (#4141) * doc: update contribitung docs on url/query params * chore: minor doc tweaks --- CONTRIBUTING.md | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e1014e48c9..ea4759213a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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