0
/ 100
Some interest. A stronger README and CI would help.
个人门户站点。
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 fixesTop fixes
Highest-impact changes first, ranked by point weight
- 1Tests18pt
Add automated tests. They prove the code works and give contributors confidence to make changes.
- 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 an Overview, Install, Usage, and Contributing section at minimum.
- 4README12pt
Add more sections (Overview, Install, Usage, Contributing) using ## headings.
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
37
No install instructions found in the README (−45 pts).
→ Add a section showing how to install dependencies.
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.
README is present.
Licensed under MIT.
Engineering
19
No tests detected anywhere in the repository.
→ Add automated tests. They prove the code works and give contributors confidence to make changes.
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.
Lockfile present (package-lock.json). Installs are reproducible.
Linter or formatter configured (lint script in package.json).
Project health
76
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.
Dependency manifest found (package.json).
Actively maintained (pushed within the last month).
.gitignore present.
Repository health signals
Activity, community, and responsiveness at scan time
Activity
- -Commits (30d / 90d)
- 0Forks
- 0Releases
Community
- -Community health
- -authors own >50% of commits
- 10Watchers
Responsiveness
- 22d 9hMedian issue response
- -Median PR merge time
- 0Open issues
Repository files13 root entries
- docs
- public
- scripts
- src
- .gitignoreGood: .gitignore present.
- astro.config.mjs
- home.png
- LICENSEGood: Licensed under MIT.
- package-lock.jsonGood: Lockfile present (package-lock.json). Installs are reproducible.
- package.jsonGood: Dependency manifest found (package.json).
- README.mdGood: 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.Good: README includes screenshots or visuals. Great for first impressions.Issue: README has no code examples (−15 pts).Fix: Show a quick-start snippet so contributors can see what using your project looks like.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.Issue: No install instructions found in the README (−45 pts).Fix: Add a section showing how to install dependencies.Issue: No run or usage instructions found (−45 pts).Fix: Add a section showing how to start or use the project.
- tsconfig.json
- wrangler.toml
Add this badge to your README
It updates automatically each time the repo is re-graded.
[](https://www.repo-grade.com/report/shawnxie94/portal)