0
/ 100
Some interest. A stronger README and CI would help.
OpenAlgo - Web Portal
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 (78).
See your top fixesTop fixes
Highest-impact changes first, ranked by point weight
- 1Tests18pt
Set scripts.test in package.json to your actual test command, e.g. "vitest" or "jest".
- 2CI/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.
- 3README12pt
Add a GIF, screenshot, or logo image. It is the fastest way to show what your project does.
- 4README12pt
Add CI/build status badges from shields.io or your CI provider to signal project health.
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.
Scorecard
Every check, grouped by category and sorted worst-first
Documentation
55
No license detected.
→ Add a LICENSE file. Without one, nobody can legally use, copy, or contribute to your code.
Contributing guidance is in the README, not a dedicated CONTRIBUTING.md (−20 pts).
→ Moving it to a CONTRIBUTING.md makes it easier to find and keeps the README focused. A dedicated file earns +47 pts base.
README is present.
README documents how to install the project.
Engineering
32
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.
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.
Test files detected (content/quant/examples/ch14/01_adf_test.py).
Lockfile present (package-lock.json). Installs are reproducible.
Linter or formatter configured (devDependency in package.json).
Project health
83
.gitignore present.
Dependency manifest found (package.json).
Repository has a description.
Actively maintained (pushed within the last month).
Repository health signals
Activity, community, and responsiveness at scan time
Activity
- -Commits (30d / 90d)
- 18Forks
- 0Releases
Community
- -Community health
- -authors own >50% of commits
- 11Watchers
Responsiveness
- -Median issue response
- <1hMedian PR merge time
- 1Open issues
Repository files17 root entries
- .claude
- app
- components
- contentGood: Test files detected (content/quant/examples/ch14/01_adf_test.py).Issue: Build artifacts or local files may be committed (content/fundamentals/examples/ch17/__pycache__/tradetools.cpython-314.pyc) (−40 pts).Fix: Remove them and add to .gitignore.
- lib
- public
- scripts
- .gitignoreGood: .gitignore present.
- CLAUDE.md
- jsconfig.json
- next.config.mjs
- open-next.config.ts
- package-lock.jsonGood: Lockfile present (package-lock.json). Installs are reproducible.
- package.jsonGood: Dependency manifest found (package.json).
- postcss.config.js
- README.mdGood: 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.
- wrangler.jsonc
Add this badge to your README
It updates automatically each time the repo is re-graded.
[](https://www.repo-grade.com/report/marketcalls/openalgo-webpage)