Skip to content

Commit 77f64dc

Browse files
committed
docs: clarify camelCase usage for badge URL parameters in badge-urls.md
1 parent db4d24f commit 77f64dc

File tree

1 file changed

+2
-1
lines changed

1 file changed

+2
-1
lines changed

doc/badge-urls.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,14 @@
66
- The `NOUN` part of the route is:
77
- singular if the badge message represents a single entity, such as the current status of a build (e.g: `/build`), or a more abstract or aggregate representation of the thing (e.g.: `/coverage`, `/quality`)
88
- plural if there are (or may) be many of the thing (e.g: `/dependencies`, `/stars`)
9-
- Parameters should always be part of the route if they are required to display a badge e.g: `:packageName`.
9+
- Parameters should always be part of the route if they are required to display a badge e.g: `:packageName` and should be camelCase.
1010
- Common optional params like, `:branch` or `:tag` should also be passed as part of the route.
1111
- Query string parameters should be used when:
1212
- The parameter is related to formatting. e.g: `/appveyor/tests/:user/:repo?compact_message`.
1313
- The parameter is for an uncommon optional attribute, like an alternate registry URL.
1414
- The parameter triggers application of alternative logic, like version semantics. e.g: `/github/v/tag/:user/:repo?sort=semver`.
1515
- Services which require a url/hostname parameter always should use a query string parameter to accept that value. e.g: `/discourse/topics?server=https://meta.discourse.org`.
16+
- Similar to parameters, query string parameters should be camelCase e.g: 'labelColor' and not 'label_color'.
1617

1718
It is convention to use the following standard routes and abbreviations across services:
1819

0 commit comments

Comments
 (0)