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

Fix typos and clarify non-promotional (#2898)

Browse Source 
Just noticed this typo and that one of the essential parts of the specification 
could be worded more clearly. It seems like the hardest to enforce with SaaS 
companies, so I don't think the explicitness will hurt.
This commit is contained in:
Olivier Lacan
2019-01-30 16:08:50 -05:00
committed by GitHub
parent 1a5336385c
commit 5af5c480db
1 changed files with 2 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
spec/SPECIFICATION.md
View File

@@ -5,8 +5,8 @@ This document specifies the visual design of Shields badges.
## Guidelines
- **legible**: it should be as easy to read the metadata provided by a badge as it is to read body copy inside of a README file regardless of display resolution
- **semantic**: the purpose information provided by a badge should be self-evident
- **non-promotional**: badges should not advertise but instead provide value through information
- **semantic**: the purpose of the information provided by a badge should be self-evident
- **non-promotional**: badges should refrain from advertising a service but instead provide value through the badge's information instead
- **concise**: one descriptive word on the left (the key), one piece of data on the right (the value)
- **hyperlinked**: badges can link to a third-party website providing more information, either related to the metadata provided by the badge or about the project the badge was used for (e.g. an open source library)