microdotblog/epilogue

0

/ 100

Documentation30
Engineering67
Health70
JavaScript17MIT3d ago
Grade a repo

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

Books! 📚

Documentation

30

README12pt0

README is present.

Install and run instructions9pt0

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

→ Add a section showing how to install dependencies.

Contributing guide5pt71

Contributing guide is detailed and thorough.

License6pt100

Licensed under MIT.

Engineering

67

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/android.yml).

Reproducibility6pt70

Lockfile present (Gemfile.lock). Installs are reproducible.

Tests18pt100

Test files detected (__tests__).

Linting and formatting5pt100

Linter or formatter configured (devDependency in package.json).

Project health

70

Repository metadata5pt40

No repository description set on GitHub (−60 pts).

→ Add a one-line description in the repo Settings → About. It appears in search results and social previews.

Dependency manifest6pt55

Dependency manifest found (Gemfile).

Activity5pt100

Actively maintained (pushed within the last month).

Housekeeping3pt100

.gitignore present.

Repository files20 root entries
  • __tests__
    Good: Test files detected (__tests__).
  • .github
    Good: CI is configured (.github/workflows/android.yml).
  • android
  • config
  • images
  • ios
  • src
  • .gitignore
    Good: .gitignore present.
  • App.js
  • app.json
  • babel.config.js
  • bun.lock
  • CONTRIBUTING.md
    Good: Contributing guide is detailed and thorough.
    Good: Contributing guide includes setup/install instructions.
    Issue: Contributing guide lacks a code style section (−8 pts).Fix: Describe your linting/formatting rules and how to run them.
    Issue: Contributing guide lacks a testing section (−8 pts).Fix: Show contributors how to run the test suite (e.g. npm test, pytest, cargo test).
    Issue: Contributing guide lacks a PR workflow section (−8 pts).Fix: Explain how to fork, branch, and open a pull request so contributors know what to expect.
    Issue: Contributing guide has no code examples (−5 pts).Fix: Add code blocks showing example commands for setup, running tests, and submitting a PR.
  • Gemfile
    Good: Dependency manifest found (Gemfile).
  • Gemfile.lock
    Good: Lockfile present (Gemfile.lock). Installs are reproducible.
  • index.js
  • LICENSE
    Good: Licensed under MIT.
  • metro.config.js
  • package.json
  • README.md
    Good: 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 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.
    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.