mwakidenis/school-management-system

0

/ 100

Documentation85
Engineering30
Health94
JavaScript183d ago
Grade a repo

Getting some notice. Tests and CI would be the fastest wins.

School Mgt System for schools

Documentation

85

Contributing guide5pt25

Contributing guidance is in the README, not a dedicated CONTRIBUTING.md (−20 pts).

→ Moving it to a CONTRIBUTING.md makes it easier to find and keeps the README focused. A dedicated file earns +47 pts base.

Install and run instructions9pt90

README documents how to install the project.

README12pt100

README is present.

License6pt100

A license file is present.

Engineering

30

Tests18pt0

No tests detected anywhere in the repository.

→ Add automated tests. They prove the code works and give contributors confidence to make changes.

Issue and PR templates6pt0

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.

CI/CD14pt40

CI is configured (.github/workflows/main.yml).

Reproducibility6pt70

Lockfile present (backend/package-lock.json). Installs are reproducible.

Linting and formatting5pt100

Linter or formatter configured (backend/eslint.config.js).

Project health

94

Housekeeping3pt60

.gitignore present.

Dependency manifest6pt100

Dependency manifest found (backend/package.json).

Repository metadata5pt100

Repository has a description.

Activity5pt100

Actively maintained (pushed within the last month).

Repository files7 root entries
  • .github
    Good: CI is configured (.github/workflows/main.yml).
  • backend
    Good: Linter or formatter configured (backend/eslint.config.js).
    Good: Lockfile present (backend/package-lock.json). Installs are reproducible.
    Good: Dependency manifest found (backend/package.json).
    Good: .gitignore present.
    Issue: Build artifacts or local files may be committed (backend/.env) (−40 pts).Fix: Remove them and add to .gitignore.
  • docs
    Good: Security policy present.
  • frontend
    Good: A license file is present.
  • uploads
  • readme.md
    Good: README is present.
    Good: README is well structured with multiple sections.
    Good: README includes screenshots or visuals. Great for first impressions.
    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.
  • updates.txt