Skip to content

Check for existence of badge when rendering the register #75

@nuest

Description

@nuest

Our community workflow mentions the step of adding a badge back on the original repo (i.e. the one in the author's account that we usually fork into our org).

The register generating code could document the missing badge as a "warning" so that, over time, we spread the badge better.

The available badges in different formats are in https://github.com/codecheckers/codecheckers.github.io/tree/master/badges

The recommended way though is to add the badges hosted on the website, see documentation at https://codecheck.org.uk/guide/community-workflow-codechecker:

If possible, coordinate with the original author(s) to add a CODE WORKS badge CODECHECK badge to their repository, e.g., by sending a pull request on GitHub, a merge request on GitLab, or sending them an HTML snippet for their personal website. The badge should link directly to the Zenodo record via the DOI. The following snippet should work in Markdown:

[![CODECHECK](https://codecheck.org.uk/img/codeworks-badge.svg)](https://doi.org/<DOI HERE>)

The repository check whether the badge is included should support any README format that is text based and match different locations for the badge, including local paths, and all available badge files and formats (svg, png, codeworks-badge, codecheck-badge).

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions