Skip to content

Add baseline status report to best practices badge site using automation proposal #283

@david-a-wheeler

Description

@david-a-wheeler

Description

Modify baseline support so that developers can report their baseline report to the Best Practices Badge site using an automation proposal (basically a long URL) and earn a badge for their excellent results.

Motivation

It's great when projects meet baseline criteria, but it's also important to make it clear to others that they've done so (e.g., through a badge) and make it easy to see the justification of why they have. This raises visibility of the project to others, too.

Proposed Solution

Basically, ask the skill to generate an automation proposal (basically a long URL) to propose the result. Maintainers can follow that URL to update their badge entry and earn a badge. Their format is like this:

https://www.bestpractices.dev/projects?as=edit&url=ENCODED_URL&
KEY=VALUE&KEY=VALUE&...

Here's a more specific example:

https://www.bestpractices.dev/projects?as=edit&
url=https%3A%2F%2Fgithub.com%2Fcurl%2Fcurl&
osps_ac_01_01_status=Met&
osps_ac_01_01_justification=GitHub+org+enforces+2FA&
osps_ac_03_01_status=Met&
osps_ac_03_01_justification=Branch+protection+enabled+on+main

Alternatives Considered

Users can post a markdown file on their own site, but that doesn't give them a badge to show off, it's not as easy to walk through it, and it doesn't give as much visibility.

The Best Practices badge site also supports JSON POST, but that is more complicated to use.

Additional Context

I expect this to be really easy; you've done the hard work.

David A. Wheeler would be willing to help, whoever that guy is :-).

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions