hashicorp/terraform-cdk
Grade a repo

93

/ 100

GradeA

A well-known project done right. Strong docs and solid engineering throughout.

Top 8% of 5,156 graded repos

Define infrastructure resources using programming constructs and provision them using HashiCorp Terraform

Documentation97
Engineering99
Health73
TypeScript5,077MPL-2.07mo ago

Top fixes

Highest-impact changes first, ranked by point weight

9 to address
  1. 1
    Install and run instructions9pt

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

  2. 2
    Reproducibility6pt

    Add additional package-ecosystem entries (especially github-actions) to keep all dependencies current.

  3. 3
    Dependency manifest6pt

    Add a one-line description to package.json. It appears in npm search and on GitHub.

  4. 4
    Dependency manifest6pt

    Add a `repository` field pointing to the GitHub URL so npm knows where the source lives.

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

97

Install and run instructions9pt90

README documents how to install the project.

Contributing guide5pt97

Contributing guide is detailed and thorough.

README12pt100

README is present.

License6pt100

Licensed under MPL-2.0.

Engineering

99

Reproducibility6pt92

Lockfile present (yarn.lock). Installs are reproducible.

Tests18pt100

Test files detected (examples/go/google-cloudrun/main_test.go).

CI/CD14pt100

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

Linting and formatting5pt100

Linter or formatter configured (.prettierrc.json).

Issue and PR templates6pt100

Issue or PR templates present.

Project health

73

Activity5pt40

Last pushed 6-12 months ago (−60 pts).

→ A recent commit signals the project is still maintained.

Dependency manifest6pt65

Dependency manifest found (go.work).

Repository metadata5pt100

Repository has a description.

Housekeeping3pt100

.gitignore present.

Repository health signals

Activity, community, and responsiveness at scan time

Activity

  • 0 / 0
    Commits (30d / 90d)
  • 518
    Forks
  • 100
    Releaseslatest 6y ago

Community

  • 87% - Good
    Community health
  • 2 bus factor
    authors own >50% of commits
  • 5,077
    Watchers

Responsiveness

  • 85d 23h
    Median issue response
  • 18h
    Median PR merge time
  • 389
    Open issues
Repository files35 root entries
  • .github
    Good: Code of conduct present.
    Good: CI is configured (.github/workflows/build.yml).
    Good: Dependabot configured for github-actions.
    Good: Issue or PR templates present.
  • .husky
  • .vscode
  • cdk.tf
  • docs
  • examples
    Good: Test files detected (examples/go/google-cloudrun/main_test.go).
  • packages
  • test
  • tools
  • website
  • .copywrite.hcl
  • .devcontainer.json
  • .dockerignore
  • .gitattributes
  • .gitignore
    Good: .gitignore present.
  • .mise.toml
  • .npmignore
  • .prettierignore
  • .prettierrc.json
    Good: Linter or formatter configured (.prettierrc.json).
  • .terraform.versions.json
  • .versionrc.json
  • .yarnrc.yml
  • BUGPROCESS.md
  • CHANGELOG.md
  • CONTRIBUTING.md
    Good: Contributing guide is detailed and thorough.
    Good: Contributing guide includes setup/install instructions.
    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.
    Good: Contributing guide includes code examples.
  • Dockerfile
    Good: Environment pinned via Dockerfile.
  • eslint.config.mjs
  • go.work
    Good: Dependency manifest found (go.work).
  • go.work.sum
  • lerna.json
  • LICENSE
    Good: Licensed under MPL-2.0.
  • nx.json
  • package.json
  • README.md
    Good: README is present.
    Good: README is well structured with multiple sections.
    Good: README includes screenshots or visuals. Great for first impressions.
    Good: README has code examples.
    Good: README links to a live demo or deployed app.
    Good: README includes status badges.
    Good: README documents how to install the project.
    Good: README documents how to run the project.
  • yarn.lock
    Good: Lockfile present (yarn.lock). Installs are reproducible.
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/hashicorp/terraform-cdk)](https://www.repo-grade.com/report/hashicorp/terraform-cdk)

More graded TypeScript repos