Lots of room to improve. Start with a README and CI.
This is an Android Mobile Application Developed using Java. It is a university project for my Mobile Platform Development course. The project incorporates as many learning material during the semester as possible.
Documentation
22
No install instructions found in the README (−45 pts).
→ Add a section showing how to install dependencies.
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.
README is present.
A license file is present.
Engineering
29
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 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.
No dependency lockfile found (−70 pts).
→ Commit the lockfile for this project's package manager so installs produce the same dependency versions everywhere.
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 (app/src/androidTest/java/com/alu/weatherwise/ExampleInstrumentedTest.java).
Project health
69
No pushes in over 2 years. Looks unmaintained (−95 pts).
→ A recent commit signals the project is alive and worth using.
.gitignore present.
Dependency manifest found (build.gradle.kts).
Repository has a description.
Repository health signals
Activity, community, and responsiveness at scan time
Activity
- —Commits (30d / 90d)
- 0Forks
- 0Releases
Community
- —Community health
- —authors own >50% of commits
- 0Watchers
Responsiveness
- —Median issue response
- <1hMedian PR merge time
- 0Open issues
Repository files16 root entries
- .ideaIssue: Build artifacts or local files may be committed (.idea/.gitignore) (−40 pts).Fix: Remove them and add to .gitignore.
- .tmp
- android
- appGood: Test files detected (app/src/androidTest/java/com/alu/weatherwise/ExampleInstrumentedTest.java).
- daemon
- gradle
- jdks
- native
- wrapperGood: A license file is present.
- .gitignoreGood: .gitignore present.
- build.gradle.ktsGood: Dependency manifest found (build.gradle.kts).
- gradle.properties
- gradlew
- gradlew.bat
- Readme.mdGood: README is present.Issue: README is very short (−20 pts). 400+ characters earns +10 pts; 1,500+ earns +20 pts.Fix: Add an Overview, Install, Usage, and Contributing section at minimum.Issue: README has some structure (−7 pts). 2-3 headings earns partial credit; 4+ earns the full +15 pts.Fix: Add more sections (Overview, Install, Usage, Contributing) using ## headings.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.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