openshift/ci-tools
Grade a repo

0

/ 100

GradeF

Getting some notice. Tests and CI would be the fastest wins.

Higher than 43% of 5,156 graded repos

DPTP Tooling

Documentation38
Engineering57
Health100
Go44Apache-2.01mo ago

A low grade is a to-do list, not a judgment of your code

Most gaps here are documentation, tests, and setup, not the code itself. Closing your top 3 gaps alone would lift this repo to A (92).

See your top fixes
Now
F
59
Potential
A
92

Top fixes

Highest-impact changes first, ranked by point weight

17 to address
  1. 1
    CI/CD14pt

    If your CI lives elsewhere (a private repo that builds this one) or this project is itself a CI/CD tool, mark this check Not Applicable. Otherwise add a GitHub Actions workflow that runs tests on each push. It takes 15 minutes and reassures contributors their changes won't break things.

  2. 2
    README12pt

    Add an Overview, Install, Usage, and Contributing section at minimum.

  3. 3
    README12pt

    Break it into sections (Overview, Install, Usage, Contributing) using Markdown headings.

  4. 4
    README12pt

    Add a GIF, screenshot, or logo image. It is the fastest way to show what your project does.

Working through the fixes? Let every push regrade itself.

The free GitHub App rescans this repo on every push and posts the grade as a commit check, so the score climbs without coming back to rescan by hand.

Install the GitHub App

Scorecard

Every check, grouped by category and sorted worst-first

Documentation

38

Install and run instructions9pt0

No install instructions found in the README (−45 pts).

→ Add a section showing how to install dependencies.

README12pt20

README is present.

Contributing guide5pt75

Contributing guide is detailed and thorough.

License6pt100

Licensed under Apache-2.0.

Engineering

57

CI/CD14pt0

No CI configuration detected in this repository.

→ If your CI lives elsewhere (a private repo that builds this one) or this project is itself a CI/CD tool, mark this check Not Applicable. Otherwise add a GitHub Actions workflow that runs tests on each push. It takes 15 minutes and reassures contributors their changes won't break things.

Issue and PR templates6pt0

No issue or PR templates found (−100 pts).

→ Add .github/ISSUE_TEMPLATE/ with bug_report.md and feature_request.md to guide contributors. It dramatically improves issue quality.

Reproducibility6pt85

Lockfile present (go.sum). Installs are reproducible.

Tests18pt100

Test files detected (cmd/applyconfig/applyconfig_test.go).

Linting and formatting5pt100

Formatting enforced (.golangci.yml).

Project health

100

Dependency manifest6pt100

Dependency manifest found (go.mod).

Repository metadata5pt100

Repository has a description.

Activity5pt100

Actively maintained (pushed within the last month).

Housekeeping3pt100

.gitignore present.

Repository health signals

Activity, community, and responsiveness at scan time

Activity

  • -
    Commits (30d / 90d)
  • 322
    Forks
  • 0
    Releases

Community

  • -
    Community health
  • -
    authors own >50% of commits
  • 44
    Watchers

Responsiveness

  • 12h
    Median issue response
  • 7h
    Median PR merge time
  • 39
    Open issues
Repository files19 root entries
  • .claude
  • cmd
    Good: Test files detected (cmd/applyconfig/applyconfig_test.go).
    Good: Environment pinned via cmd/vault-secret-collection-manager/docker-compose.yaml.
  • hack
  • images
  • pkg
  • test
  • .ci-operator.yaml
  • .coderabbit.yaml
  • .gitignore
    Good: .gitignore present.
  • .golangci.yml
    Good: Formatting enforced (.golangci.yml).
  • .snyk
  • .snyk-ignore
  • CONTRIBUTING.md
    Good: Contributing guide is detailed and thorough.
    Issue: Contributing guide lacks a setup section (−12 pts).Fix: Show new contributors how to get a local dev environment running.
    Issue: Contributing guide lacks a code style section (−8 pts).Fix: Describe your linting/formatting rules and how to run them.
    Good: Contributing guide explains how to run tests.
    Good: Contributing guide describes the PR/review workflow.
    Issue: Contributing guide has no code examples (−5 pts).Fix: Add code blocks showing example commands for setup, running tests, and submitting a PR.
  • go.mod
    Good: Dependency manifest found (go.mod).
  • go.sum
    Good: Lockfile present (go.sum). Installs are reproducible.
  • LICENSE
    Good: Licensed under Apache-2.0.
  • Makefile
  • OWNERS
  • README.md
    Good: README is present.
    Issue: README is very short (−20 pts). 400+ characters earns +10 pts; 1,500+ earns +20 pts.Fix: Add an Overview, Install, Usage, and Contributing section at minimum.
    Issue: README has little structure (−15 pts). Add 2-3 headings for +8 pts; 4+ earns +15 pts.Fix: Break it into sections (Overview, Install, Usage, Contributing) using Markdown headings.
    Issue: No screenshots or images in the README (−20 pts).Fix: Add a GIF, screenshot, or logo image. It is the fastest way to show what your project does.
    Issue: README has no code examples (−15 pts).Fix: Show a quick-start snippet so contributors can see what using your project looks like.
    Good: README links to a live demo or deployed app.
    Issue: No status badges in the README (−10 pts).Fix: Add CI/build status badges from shields.io or your CI provider to signal project health.
    Issue: No install instructions found in the README (−45 pts).Fix: Add a section showing how to install dependencies.
    Issue: No run or usage instructions found (−45 pts).Fix: Add a section showing how to start or use the project.
RepoGrade badge preview

Add this badge to your README

It updates automatically each time the repo is re-graded.

[![RepoGrade](https://www.repo-grade.com/api/badge/openshift/ci-tools)](https://www.repo-grade.com/report/openshift/ci-tools)

More graded Go repos