nmind/proceedings

Proposal: Automated Badge Generation for Repository Standards Compliance

Opened this issue · 0 comments

ReinderVosDeWael commented

Overview

This proposal aims to introduce a feature for automatic badge generation in GitHub repositories to showcase their standards compliance. This will provide a visual and easily accessible way to understand the compliance status of a repository.

Implementation Plan

1. Dynamic Badge URL

  • Each repository will have a unique, standardized URL that redirects to the current compliance badge.
  • Format: ${DOMAIN}/${REPOSITORY}/badge

2. Badge Design and Color Coding

  • The badge will display the repository's compliance score.
  • Example format: badge
  • Color coding for compliance levels:
    • Red: Compliance <= 25%
    • Orange: Compliance > 25% and <= 50%
    • Yellow: Compliance > 50% and <= 75%
    • Green: Compliance > 75%

3. Badge Functionality

  • Users will be encouraged to have their badges link to their NMIND page.

Goal

The aim is to create an automated system that visually represents a repository's adherence to set standards, making it simpler for users to gauge compliance at a glance.

If there is an interest in this, I'd be happy to have a look at making a PR.