Skip to content

Commit b7a2355

Browse files
Rob Tjalmadlabordus
authored andcommitted
Added short explanation about adding custom badge for LFX Security
Signed-off-by: Rob Tjalma <[email protected]>
1 parent 24bdd76 commit b7a2355

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

CONTRIBUTING.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -255,6 +255,20 @@ $ mvn package eclipse:eclipse
255255
256256
After importing the projects with either method, install SonarLint for quicker feedback on potential sonar issues.
257257
258+
#### Adding custom badges to your README
259+
Badges are great for quickly checking several status reports of a specific repository.
260+
Sometimes a application doesn't serve badges ([LFX Security tool](https://security.lfx.linuxfoundation.org/) for example), and you need to do it yourself.
261+
We use [shields.io](https://shields.io/) for this problem.
262+
263+
In case of the LFX Security Tool, we used the following:
264+
- Go to [shields.io](https://shields.io/).
265+
- Go to the 'Dynamic' section.
266+
- Choose JSON as data type.
267+
- Insert 'LFX Security Tool' as the label.
268+
- Insert the API to use, in case of our LFX Security tool projects we use [this API](https://api.security.lfx.linuxfoundation.org/v1/project/e8b6fdf9-2686-44c5-bbaa-6965d04ad3e1/issues).
269+
- Now you can query using JsonPath. To get all open high issues from the 'CoMPAS Core' project, use `issues[?(@['repository-name'] == 'compas-core')]['high-open-issues']`.
270+
- Choose a color and a pre- or surfix text.
271+
258272
## Styleguides
259273
260274
### Git Commit Messages

0 commit comments

Comments
 (0)