Huge star count, but README, tests, and CI need real investment.
C++那些事
Documentation
55
No license detected.
→ Add a LICENSE file. Without one, nobody can legally use, copy, or contribute to your code.
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.
Engineering
0
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 dependency lockfile found (−70 pts).
→ Commit the lockfile for this project's package manager so installs produce the same dependency versions everywhere.
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.
Project health
47
No dependency manifest detected at root.
→ Add a manifest (package.json, pyproject.toml, Cargo.toml, go.mod, etc.) so others can install dependencies in one command.
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.
Actively maintained (pushed within 3 months).
.gitignore present.
Repository files19 root entries
- .vscode
- basic_content
- codingStyleIdioms
- concurrency
- cpp2.0
- design_pattern
- effective_cpp
- english
- extension
- img
- learn_class
- practical_exercises
- proj
- src_analysis
- tool
- .gitignoreGood: .gitignore present.
- README_EN.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.Good: README includes status badges.Good: README documents how to install the project.Good: README documents how to run the project.
- README.md
- WORKSPACE