Some interest. A stronger README and CI would help.
A 30-day public U.S. stock challenge: follow a 5000 HKD 🦞 claw through live market days.
Documentation
33
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.
No install instructions found in the README (−45 pts).
→ Add a section showing how to install dependencies.
README is present.
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 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 (xhs-agent/package-lock.json). Installs are reproducible.
Project health
100
Dependency manifest found (xhs-agent/package.json).
Repository has a description.
Actively maintained (pushed within the last month).
.gitignore present.
Repository files6 root entries
- docs
- strategies
- xhs-agentGood: Lockfile present (xhs-agent/package-lock.json). Installs are reproducible.Good: Dependency manifest found (xhs-agent/package.json).
- .gitignoreGood: .gitignore present.
- README.mdGood: README is present.Good: README is well structured with multiple sections.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.Issue: No live demo link in the README (−20 pts).Fix: Link to a deployed version, docs site, or demo video. Users want to see it running.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.Good: README documents how to run the project.
- README.zh-CN.md