codecheckers / codecheckers/discussion

Dynamic SVG badges for CODECHECK reports

Open
#24 1 comment 0 reactions 0 assignees View on GitHub
Dominant language
No language data
Stars
0
Forks
0
PR merge metrics
No merged PRs in 30d

Description

During the review of our codecheck paper, a reviewer [commented](https://f1000research.com/articles/10-253/v1#referee-response-82470)

> The badge that is delivered would need some time information since
> the check is valid at one point in time (with a given software stack) and
> does not guarantee future runs.

So, what we were thinking was extending the [codecheck logo](https://codecheck.org.uk/img/codecheck_logo.svg) by another line to include either a timestamp, or even just the certificate number (which starts with the year).
![codecheck_logo](https://user-images.githubusercontent.com/1095067/153608345-bc750cbf-5dbc-4abc-b0e2-635d1a1305da.svg)

I was thinking of having the URL split over two lines, e.g.

> https://codecheck.org.uk/
> cert/2022-001

(and if so, then we'd need a bit of extra website work to make the URL [https://codecheck.org.uk/cert/2022-001]

@nuest did you make the previous version of the logo? If we added an extra line, could we then use sed to generate new ones?

Alternatively, I see there are now several implementations of 'plain' SVG badges,
https://forthebadge.com/generator/
https://metacpan.org/pod/Badge::Simple
![codecheck org uk-cert_2022-01](https://user-images.githubusercontent.com/1095067/153607787-271e452c-60b0-454c-ad63-d30995a072f8.svg)

but this style looks a bit too long to me.

Contributor guide

No contributing guide indexed for this repository

Research direction

Start with the linked codecheck_logo.svg and the proposed https://codecheck.org.uk/cert/2022-001 URL, then compare the Forthebadge generator and Badge::Simple examples. The work is done when the project has agreed on a time or certificate format, generated badge approach, and corresponding certificate URL support.

Written by the indexing model from the issue text.

Assessment

Tech stack
xml
Domain
design, web-dev
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.