Getting some notice. Tests and CI would be the fastest wins.
This project is a Computer Vision implementation of general hierarchical pattern discovery principles introduced in README
Documentation
61
No install instructions found in the README (−45 pts).
→ Add a section showing how to install dependencies.
README is present.
Contributing guide is detailed and thorough.
Licensed under MIT.
Engineering
38
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 (Requirements.txt). Installs are reproducible.
Test files detected (frame_2D_alg/alternative versions/test_sets.py).
Project health
94
.gitignore present.
Dependency manifest found (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)
- 40Forks
- 0Releases
Community
- —Community health
- —authors own >50% of commits
- 98Watchers
Responsiveness
- 2hMedian issue response
- <1hMedian PR merge time
- 4Open issues
Repository files10 root entries
- .ideaIssue: Build artifacts or local files may be committed (.idea/.name) (−40 pts).Fix: Remove them and add to .gitignore.
- frame_2D_algGood: Test files detected (frame_2D_alg/alternative versions/test_sets.py).
- line_1D_alg
- .gitignoreGood: .gitignore present.
- CONTRIBUTING.mdGood: Contributing guide is detailed and thorough.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).Issue: Contributing guide lacks a PR workflow section (−8 pts).Fix: Explain how to fork, branch, and open a pull request so contributors know what to expect.Issue: Contributing guide has no code examples (−5 pts).Fix: Add code blocks showing example commands for setup, running tests, and submitting a PR.
- index.html
- LICENSEGood: Licensed under MIT.
- README.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.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.
- Requirements.txtGood: Lockfile present (Requirements.txt). Installs are reproducible.Good: Dependency manifest found (Requirements.txt).
- WIKI.md