0
/ 100
Some interest. A stronger README and CI would help.
Cranberry Punch is a Delicious Attendance Management System for SMEs to get thier teams to Punch In and close their work timings.
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 C (75).
See your top fixesTop fixes
Highest-impact changes first, ranked by point weight
- 1Tests18pt
Wire your tests to a documented command (e.g. a test script in your build config) so the suite is reproducible.
- 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 a README.md describing what the project does, how to install it, and how to run it.
- 4Install and run instructions9pt
Add a section showing how to install dependencies.
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
22
No README found in the repository.
→ Add a README.md describing what the project does, how to install it, and how to run it.
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.
Licensed under Other.
Engineering
49
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 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.
Test files detected (phpunit.xml).
Lockfile present (composer.lock). Installs are reproducible.
PHP linting configured (.editorconfig).
Project health
75
No pushes in over 2 years. Looks unmaintained (−95 pts).
→ A recent commit signals the project is alive and worth using.
Dependency manifest found (composer.json).
Repository has a description.
.gitignore present.
Repository files29 root entries
- app
- bootstrap
- config
- cypress
- database
- lang
- public
- resources
- routes
- storage
- tests
- .editorconfigGood: PHP linting configured (.editorconfig).
- .env.example
- .gitattributes
- .gitignoreGood: .gitignore present.
- .nvmrcGood: Environment pinned via .nvmrc.
- API.md
- artisan
- composer.jsonGood: Dependency manifest found (composer.json).
- composer.lockGood: Lockfile present (composer.lock). Installs are reproducible.
- cypress.config.js
- LICENSE.mdGood: Licensed under Other.
- package-lock.json
- package.json
- phpunit.xmlGood: Test files detected (phpunit.xml).
- postcss.config.js
- README.mdIssue: No install instructions found in the README (−45 pts).Fix: Add a section showing how to install dependencies.Issue: No run or usage instructions found (−45 pts).Fix: Add a section showing how to start or use the project.
- tailwind.config.js
- vite.config.js
Add this badge to your README
It updates automatically each time the repo is re-graded.
[](https://www.repo-grade.com/report/cranberryware/cranberry-punch)