Skip to content

Add OpenSSF Best Practices badge to README #78

@chicks-net

Description

@chicks-net

Summary

Register the project with the OpenSSF Best Practices Program and add the resulting badge to the README.

Why

The OpenSSF (Open Source Security Foundation) Best Practices badge signals to users and contributors that the project follows security and quality best practices. It also gets the repo listed in the OpenSSF registry, which increases discoverability and adds credibility — especially useful for a tool that handles GitHub tokens and CI/CD pipeline visibility.

Tasks

  • Register fini-net/gh-observer at https://www.bestpractices.dev/en/projects/new
  • Work through the criteria checklist (passing level is reasonable starting target)
  • Once registered, add the badge to README.md alongside the existing shields.io badges
    • Badge format: [![OpenSSF Best Practices](https://www.bestpractices.dev/projects/<ID>/badge)](https://www.bestpractices.dev/projects/<ID>)
  • Identify any gaps in current practices and address them (e.g., security policy, contribution guide, signed releases)

Notes

  • The project already has several passing criteria: OSI-approved license (MIT), public repo, version control, automated tests, CI workflow
  • Build attestations via GitHub Actions already cover supply chain security requirements
  • A SECURITY.md policy file may be needed to complete the security disclosure criteria

Metadata

Metadata

Assignees

Labels

choreChores or maintenance tasks, like version updates.documentationImprovements or additions to documentation

Type

No fields configured for Task.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions