narattscoward/healthyme-ios-final-project

0

/ 100

Documentation35
Engineering0
Health46
Swift07mo ago
Grade a repo

Lots of room to improve. Start with a README and CI.

HealthyMe is an iOS app for tracking daliy healthy habits and help user naviagate their daily lifestyle.

Documentation

35

License6pt0

No license detected.

→ Add a LICENSE file. Without one, nobody can legally use, copy, or contribute to your code.

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 instructions9pt45

README documents how to install the project.

README12pt50

README is present.

Engineering

0

Tests18pt0

No tests detected anywhere in the repository.

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

CI/CD14pt0

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.

Linting and formatting5pt0

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.

Reproducibility6pt0

No dependency lockfile found (−70 pts).

→ Commit Package.resolved for application projects so Swift Package Manager resolves the same versions.

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.

Project health

46

Dependency manifest6pt0

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.

Activity5pt40

Last pushed 6-12 months ago (−60 pts).

→ A recent commit signals the project is still maintained.

Housekeeping3pt60

.gitignore present.

Repository metadata5pt100

Repository has a description.

Repository health signals

Activity, community, and responsiveness at scan time

Activity

  • —
    Commits (30d / 90d)
  • 0
    Forks
  • 0
    Releases

Community

  • —
    Community health
  • —
    authors own >50% of commits
  • 0
    Watchers

Responsiveness

  • —
    Median issue response
  • <1h
    Median PR merge time
  • 0
    Open issues
Repository files8 root entries
  • HealthyMe
  • HealthyMe.xcodeproj
  • HealthyMeWidget
  • .DS_Store
    Issue: Build artifacts or local files may be committed (.DS_Store) (−40 pts).Fix: Remove them and add to .gitignore.
  • .gitignore
    Good: .gitignore present.
  • Config.template.xcconfig
  • HealthyMeWidgetExtension.entitlements
  • README.md
    Good: 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.
    Good: README has code examples.
    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.
    Good: README documents how to install the project.
    Issue: No run or usage instructions found (−45 pts).Fix: Add a section showing how to start or use the project.