Name: RepoGrade report for jbro885/blackscholes
Item: jbro885/blackscholes
Rating: 63
Author: RepoGrade

jbro885/blackscholes

Grade a repo

/ 100

GradeD

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

Higher than 47% of 5,156 graded repos

Documentation46

Engineering85

Health33

06y 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 B (85).

See your top fixes

Now

Potential

Top fixes

Highest-impact changes first, ranked by point weight

16 to address

1
README12pt
Add an Overview, Install, Usage, and Contributing section at minimum.
2
README12pt
Add more sections (Overview, Install, Usage, Contributing) using ## headings.
3
README12pt
Add a GIF, screenshot, or logo image. It is the fastest way to show what your project does.
4
README12pt
Show a quick-start snippet so contributors can see what using your project looks like.

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

2 checks need work

README12pt

README is present.

Install and run instructions9pt

README documents how to install the project.

Contributing guide5pt

CONTRIBUTING guide found.

License6pt

100

A license file is present.

Engineering

1 checks need work

Issue and PR templates6pt

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.

Reproducibility6pt

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

Tests18pt

100

Test files detected (node_modules/@firebase/app/dist/packages/app/test).

CI/CD14pt

100

CI is configured (node_modules/@nomiclabs/buidler/node_modules/eth-sig-util/node_modules/ethereumjs-abi/.travis.yml).

Linting and formatting5pt

100

Linter or formatter configured (node_modules/@firebase/installations/.eslintrc.js).

Project health

3 checks need work

Repository metadata5pt

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.

Housekeeping3pt

No .gitignore found (−60 pts).

→ Add a .gitignore to keep build output, node_modules, and secrets out of version control.

Activity5pt

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

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

Dependency manifest6pt

100

Dependency manifest found (package.json).

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 files10 root entries

build
contracts
migrations
node_modules
Good: A license file is present.
Good: CONTRIBUTING guide found.
Issue: CONTRIBUTING guide contents could not be read (−28 pts vs a readable file).Fix: Move the file to the repo root or docs/CONTRIBUTING.md so its setup, style, test, and PR sections can be graded.
Good: Code of conduct present.
Good: Test files detected (node_modules/@firebase/app/dist/packages/app/test).
Good: CI is configured (node_modules/@nomiclabs/buidler/node_modules/eth-sig-util/node_modules/ethereumjs-abi/.travis.yml).
Good: Linter or formatter configured (node_modules/@firebase/installations/.eslintrc.js).
Good: Environment pinned via node_modules/has-symbol-support-x/.nvmrc.
Good: Security policy present.
Issue: Build artifacts or local files may be committed (node_modules/.bin) (−40 pts).Fix: Remove them and add to .gitignore.
test
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.
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 some structure (−7 pts). 2-3 headings earns partial credit; 4+ earns the full +15 pts.Fix: Add more sections (Overview, Install, Usage, Contributing) using ## 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.
Issue: No live demo link in the README (−20 pts).Fix: Link to a deployed version, docs site, or demo video. Users want to see it running.
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.
Issue: No run or usage instructions found (−45 pts).Fix: Add a section showing how to start or use the project.
truffle-config.js
tsconig.json

Add this badge to your README

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

[![RepoGrade](https://www.repo-grade.com/api/badge/jbro885/blackscholes)](https://www.repo-grade.com/report/jbro885/blackscholes)