jeffdcamp/android-template

0

/ 100

Documentation23
Engineering68
Health94
Kotlin1141d ago
Grade a repo

Popular for its size, but the engineering basics lag behind the interest.

Basic Android Template for new Android Applications

Documentation

23

Install and run instructions9pt0

No install instructions found in the README (−45 pts).

→ Add a section showing how to install dependencies.

License6pt0

No license detected.

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

Contributing guide5pt0

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.

README12pt60

README is present.

Engineering

68

Reproducibility6pt0

No dependency lockfile found (−70 pts).

→ Commit the lockfile for this project's package manager so installs produce the same dependency versions everywhere.

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.

Tests18pt80

Test files detected (app/src/androidTest/java/org/jdc/template/ux/SmokeTest.kt).

CI/CD14pt100

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

Linting and formatting5pt100

Java/Kotlin linting configured (lint step in CI workflow).

Project health

94

Housekeeping3pt60

.gitignore present.

Dependency manifest6pt100

Dependency manifest found (build.gradle.kts).

Repository metadata5pt100

Repository has a description.

Activity5pt100

Actively maintained (pushed within the last month).

Repository health signals

Activity, community, and responsiveness at scan time

Activity

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

Community

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

Responsiveness

  • <1h
    Median issue response
  • 3h
    Median PR merge time
  • 1
    Open issues
Repository files20 root entries
  • .github
    Good: CI is configured (.github/workflows/alpha.yml).
  • .idea
    Issue: Build artifacts or local files may be committed (.idea/icon.png) (−40 pts).Fix: Remove them and add to .gitignore.
  • .run
  • app
    Good: Test files detected (app/src/androidTest/java/org/jdc/template/ux/SmokeTest.kt).
  • buildSrc
  • docs
  • gradle
  • shared
  • .gitignore
    Good: .gitignore present.
  • AGENTS.md
  • api-playstore-dummy.json
  • build.gradle.kts
    Good: Dependency manifest found (build.gradle.kts).
  • CLAUDE.md
  • GEMINI.md
  • gradle.properties
  • gradlew
  • gradlew.bat
  • Jenkinsfile
  • README.md
    Good: README is present.
    Issue: README is fairly short (−10 pts). At 400+ chars you get partial credit; 1,500+ earns the full +20 pts.Fix: Expand with a description, install steps, usage, and examples.
    Issue: README has little structure (−15 pts). Add 2-3 headings for +8 pts; 4+ earns +15 pts.Fix: Break it into sections (Overview, Install, Usage, Contributing) using Markdown headings.
    Good: README includes screenshots or visuals. Great for first impressions.
    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.
    Good: README includes status badges.
    Issue: 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.
  • settings.gradle.kts