ybhgl/reminder
Grade a repo

0

/ 100

GradeF

Fresh project. Add a README and CI early.

一款简洁的安卓纪念日/倒数日管理应用

Documentation21
Engineering41
Health94
Kotlin8today

Documentation

21

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.

README12pt55

README is present.

Engineering

41

Linting and formatting5pt0

No Java/Kotlin linter configured.

→ Add Checkstyle or Spotless for Java formatting, or ktlint/Detekt for Kotlin. Run it via Maven/Gradle or as a CI step.

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.

CI/CD14pt40

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

Tests18pt80

Test files detected (app/src/androidTest/java/com/ybhgl/reminder/ExampleInstrumentedTest.kt).

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)
  • 0
    Forks
  • 8
    Releaseslatest 4d ago

Community

  • -
    Community health
  • -
    authors own >50% of commits
  • 8
    Watchers

Responsiveness

  • -
    Median issue response
  • -
    Median PR merge time
  • 0
    Open issues
Repository files12 root entries
  • .github
    Good: CI is configured (.github/workflows/release.yml).
  • .idea
    Issue: Build artifacts or local files may be committed (.idea/.gitignore) (−40 pts).Fix: Remove them and add to .gitignore.
  • app
    Good: Test files detected (app/src/androidTest/java/com/ybhgl/reminder/ExampleInstrumentedTest.kt).
  • gradle
  • screenshots
  • .gitignore
    Good: .gitignore present.
  • build.gradle.kts
    Good: Dependency manifest found (build.gradle.kts).
  • gradle.properties
  • gradlew
  • gradlew.bat
  • README.md
    Good: README is present.
    Good: README is well structured with multiple sections.
    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.
    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.
    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