48
/ 100
Lots of room to improve. Start with a README and CI.
针对自己的 Quantum Bit 博客定制的私域知识问答系统
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 (81).
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 CI/build status badges from shields.io or your CI provider to signal project health.
- 4Install and run instructions9pt
Add a .env.example listing all required environment variables so contributors know what to set up.
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
78
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.
README documents how to install the project.
Licensed under Apache-2.0.
Engineering
10
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 config found.
→ Add a linter config such as .eslintrc.json, .prettierrc, ruff.toml, or .golangci.yml to enforce consistent code style.
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 (data_process/requirements.txt). Installs are reproducible.
Project health
94
.gitignore present.
Dependency manifest found (data_process/requirements.txt).
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)
- 0Forks
- 0Releases
Community
- 42% - WeakCommunity health
- 1 bus factorlowauthor own >50% of commits
- 9Watchers
Responsiveness
- -Median issue response
- -Median PR merge time
- 0Open issues
Repository files14 root entries
- data
- data_processGood: Lockfile present (data_process/requirements.txt). Installs are reproducible.Good: Dependency manifest found (data_process/requirements.txt).
- llm_service
- nginx_balance
- rag_chatIssue: Build artifacts or local files may be committed (rag_chat/.env) (−40 pts).Fix: Remove them and add to .gitignore.
- rag_service
- README.assetsGood: README is present.Good: README is well structured with multiple sections.Good: README includes screenshots or visuals. Great for first impressions.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.
- script
- .gitignoreGood: .gitignore present.
- build.sh
- DockerfileGood: Environment pinned via Dockerfile.
- LICENSEGood: Licensed under Apache-2.0.
- README.md
- start.sh
Add this badge to your README
It updates automatically each time the repo is re-graded.
[](https://www.repo-grade.com/report/logistic98/blog-rag)