Getting noticed, but rough fundamentals could turn visitors away.
Developer documentation for the Kick Dev API
Documentation
43
No license detected.
→ Add a LICENSE file. Without one, nobody can legally use, copy, or contribute to your code.
No install instructions found in the README (−45 pts).
→ Add a section showing how to install dependencies.
README is present.
Contributing guide is too short for full depth credit (−6 pts). 400+ words earns the full +12 pts.
→ Add setup instructions, code style notes, and how to run tests.
Engineering
12
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.
Issue or PR templates present.
Project health
58
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.
Repository has a description.
Actively maintained (pushed within the last month).
.gitignore present.
Repository health signals
Activity, community, and responsiveness at scan time
Activity
- —Commits (30d / 90d)
- 36Forks
- 0Releases
Community
- —Community health
- —authors own >50% of commits
- 132Watchers
Responsiveness
- 14hMedian issue response
- 6hMedian PR merge time
- 56Open issues
Repository files15 root entries
- .gitbook
- .githubGood: Issue or PR templates present.
- apis
- community
- drops
- events
- getting-started
- organizations
- readmeGood: 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.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.Good: README documents how to run the project.
- scopes
- .gitignoreGood: .gitignore present.
- changelog.md
- CONTRIBUTING.mdIssue: Contributing guide is too short for full depth credit (−6 pts). 400+ words earns the full +12 pts.Fix: Add setup instructions, code style notes, and how to run tests.Issue: Contributing guide lacks a setup section (−12 pts).Fix: Show new contributors how to get a local dev environment running.Issue: Contributing guide lacks a code style section (−8 pts).Fix: Describe your linting/formatting rules and how to run them.Issue: Contributing guide lacks a testing section (−8 pts).Fix: Show contributors how to run the test suite (e.g. npm test, pytest, cargo test).Good: Contributing guide describes the PR/review workflow.Issue: Contributing guide has no code examples (−5 pts).Fix: Add code blocks showing example commands for setup, running tests, and submitting a PR.
- README.md
- SUMMARY.md