agubernikoff/phase-0-html-document-structure-lab
Grade a repo

0

/ 100

GradeD

Rough and inactive. Tests, CI, and a fuller README would revive it.

Higher than 46% of 5,156 graded repos
Documentation80
Engineering57
Health43
0Other4y 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 C (74).

See your top fixes
Now
D
62
Potential
C
74

Top fixes

Highest-impact changes first, ranked by point weight

24 to address
  1. 1
    CI/CD14pt

    Add a step like `run: npm test`, `run: pytest`, or `run: tox` to your workflow file.

  2. 2
    CI/CD14pt

    Add `pull_request:` to the workflow `on:` triggers.

  3. 3
    CI/CD14pt

    Add a lint step to catch style issues automatically.

  4. 4
    CI/CD14pt

    Add `tsc --noEmit`, `mypy`, or `cargo check` to catch type errors before they merge.

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

80

Contributing guide5pt61

Contributing guide is too short for full depth credit (−6 pts). 400+ words earns the full +12 pts.

→ Add setup instructions, code style notes, and how to run tests.

README12pt70

README is present.

Install and run instructions9pt90

README documents how to install the project.

License6pt100

Licensed under Other.

Engineering

57

Linting and formatting5pt0

No linter or formatter found.

→ Add ESLint (eslint.config.js) and/or Prettier (.prettierrc), install them as devDependencies, and add a `lint` script to package.json.

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.

CI/CD14pt40

CI is configured (.github/workflows/canvas-sync-html.yml).

Reproducibility6pt70

Lockfile present (package-lock.json). Installs are reproducible.

Tests18pt100

Test files detected (test).

Project health

43

Repository metadata5pt0

No repository description set on GitHub (−60 pts).

→ Add a one-line description in the repo Settings → About. It appears in search results and social previews.

Activity5pt5

No pushes in over 2 years. Looks unmaintained (−95 pts).

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

Dependency manifest6pt82

Dependency manifest found (package.json).

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 files12 root entries
  • .github
    Good: CI is configured (.github/workflows/canvas-sync-html.yml).
  • test
    Good: Test files detected (test).
  • .canvas
  • .gitignore
    Good: .gitignore present.
  • .learn
  • CONTRIBUTING.md
    Issue: Contributing guide is too short for full depth credit (−6 pts). 400+ words earns the full +12 pts.Fix: Add setup instructions, code style notes, and how to run tests.
    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.
    Issue: Contributing guide lacks a testing section (−8 pts).Fix: Show contributors how to run the test suite (e.g. npm test, pytest, cargo test).
    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.
  • index.html
  • LICENSE.md
    Good: Licensed under Other.
  • package-lock.json
    Good: Lockfile present (package-lock.json). Installs are reproducible.
  • package.json
    Good: Dependency manifest found (package.json).
  • 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.
  • style.css
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/agubernikoff/phase-0-html-document-structure-lab)](https://www.repo-grade.com/report/agubernikoff/phase-0-html-document-structure-lab)

More graded repos