nkvoll/terraform-provider-warpstream
Grade a repo

0

/ 100

GradeC

Solid engineering. The main gap is visibility.

Top 35% of 5,156 graded repos

Official Terraform Provider for WarpStream

Documentation70
Engineering86
Health68
0MPL-2.01y ago

Top fixes

Highest-impact changes first, ranked by point weight

11 to address
  1. 1
    README12pt

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

  2. 2
    README12pt

    Add CI/build status badges from shields.io or your CI provider to signal project health.

  3. 3
    Install and run instructions9pt

    Add a .env.example listing all required environment variables so contributors know what to set up.

  4. 4
    Reproducibility6pt

    Add a Dockerfile, .nvmrc, or .python-version to pin the runtime version and make the environment reproducible.

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

70

Contributing guide5pt0

No CONTRIBUTING.md found (−47 pts base + up to −53 pts more for content).

→ Add a CONTRIBUTING.md telling newcomers how to get involved. Include setup, code style, test, and PR instructions.

README12pt70

README is present.

Install and run instructions9pt90

README documents how to install the project.

License6pt100

Licensed under MPL-2.0.

Engineering

86

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.

Reproducibility6pt87

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

Tests18pt100

Test files detected (internal/provider/agent_key_resource_test.go).

CI/CD14pt100

CI is configured (.github/workflows/test.yml).

Linting and formatting5pt100

Formatting enforced (.golangci.yml).

Project health

68

Activity5pt20

No pushes in over a year (−80 pts).

→ A recent commit signals the project is alive and worth contributing to.

Repository metadata5pt60

Repository has a description.

Dependency manifest6pt100

Dependency manifest found (go.mod).

Housekeeping3pt100

.gitignore present.

Repository health signals

Activity, community, and responsiveness at scan time

Activity

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

Community

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

Responsiveness

  • -
    Median issue response
  • -
    Median PR merge time
  • 0
    Open issues
Repository files16 root entries
  • .github
    Good: CI is configured (.github/workflows/test.yml).
    Good: Dependabot configured for gomod.
  • docs
  • examples
  • internal
    Good: Test files detected (internal/provider/agent_key_resource_test.go).
  • templates
  • tools
  • .gitignore
    Good: .gitignore present.
  • .golangci.yml
    Good: Formatting enforced (.golangci.yml).
  • .goreleaser.yml
  • GNUmakefile
  • go.mod
    Good: Dependency manifest found (go.mod).
  • go.sum
    Good: Lockfile present (go.sum). Installs are reproducible.
  • LICENSE
    Good: Licensed under MPL-2.0.
  • main.go
  • README.md
    Good: README is present.
    Good: README is well structured with multiple sections.
    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.
    Good: README has code examples.
    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.
    Good: README documents how to install the project.
    Good: README documents how to run the project.
  • terraform-registry-manifest.json
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/nkvoll/terraform-provider-warpstream)](https://www.repo-grade.com/report/nkvoll/terraform-provider-warpstream)

More graded repos