0
/ 100
Real traction, but rough engineering makes it hard for contributors to trust.
Nodejs学习笔记以及经验总结，公众号"程序猿小卡"
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 D (67).
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 more sections (Overview, Install, Usage, Contributing) using ## headings.
- 4README12pt
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.
Scorecard
Every check, grouped by category and sorted worst-first
Documentation
44
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 Other.
Engineering
9
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 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.
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 (examples/2019.08.23-advanced-request-proxy/package-lock.json). Installs are reproducible.
Project health
69
No pushes in over 2 years. Looks unmaintained (−95 pts).
→ A recent commit signals the project is alive and worth using.
Dependency manifest found (Gemfile).
Repository has a description.
.gitignore present.
Repository files17 root entries
- _pages
- .vscode
- assets
- docs
- examplesGood: Lockfile present (examples/2019.08.23-advanced-request-proxy/package-lock.json). Installs are reproducible.
- express
- 模块
- 进阶
- _config.yml
- .gitignoreGood: .gitignore present.
- book.json
- GemfileGood: Dependency manifest found (Gemfile).
- index.md
- LICENSEGood: Licensed under Other.
- package.json
- README.mdGood: README is present.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.
- SUMMARY.md
Add this badge to your README
It updates automatically each time the repo is re-graded.
[](https://www.repo-grade.com/report/chyingp/nodejs-learning-guide)