Add Badge Specification

[confused-Techie]

Requirements

• Filling out the template is required.

• All new code requires tests to ensure against regressions.

  • However, if your PR contains zero code changes, feel free to select the checkmark below to indicate so.

• [ ] Have you ran tests against this code?

• [X] This PR contains zero code changes.

Description of the Change

This PR adds a document explaining the specification of a badge, along with it's valid parts. Allowing clients to easily create code to utilize badges to their full capability, without any vagueness on what properties a badge may or may not have.

[confused-Techie]

@Daeraxa I appreciate the review. All your suggestions looked good, and especially like the wording things better for use, and context of the audience of a badge. (And yeah always mess up on the AmE lol)

And the point about a limit is interesting. Obviously in this spec I haven't considered such a need. And would be interesting to try and find a proper limit if we planned on setting one.

The easy answer is leave it up to the client if they'd like to set a limit to how many can be shown for any one package, which could then be determined stylistically rather than anything. Although until we open up the ability to add badges I'd think about 5 is a good 'soft' limit for us to set. Although we could codify something like 10?

That's way more than I could see any single badge needing, and would ensure someone doesn't fill a webpage up with their badges.

[Daeraxa]

Agree there, don't really see a need for more than 5 badges for most uses. Was going to say something about the client not displaying all the badges that might be present but thinking about that it is still a client issue as they can pick, sort and filter badges as it sees fit.

[confused-Techie]

Yeah good point, but I've added a note about the amount of badges. Specifying it's not a hard rule