Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Proposal: Automated Badge Generation for Repository Standards Compliance #2

Open
ReinderVosDeWael opened this issue Nov 20, 2023 · 0 comments

Comments

@ReinderVosDeWael
Copy link

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant