m-cmp/mc-observability

0

/ 100

Documentation64
Engineering55
Health78
Java8Apache-2.01d ago
Grade a repo

Early stage. Tests, CI, and a strong README would raise this score quickly.

Documentation

64

README12pt25

README is present.

Contributing guide5pt52

CONTRIBUTING guide is very brief (−12 pts for depth). 150+ words earns +6 pts; 400+ earns +12 pts.

→ Add setup instructions, code style notes, and how to run tests.

Install and run instructions9pt100

README documents how to install the project.

License6pt100

Licensed under Apache-2.0.

Engineering

55

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.

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/CD14pt57

CI is configured (.github/workflows/generate_swagger.yaml).

Tests18pt80

Test files detected (java/mc-o11y-manager/src/test).

Reproducibility6pt80

Lockfile present (front/package-lock.json). Installs are reproducible.

Project health

78

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.

Housekeeping3pt60

.gitignore present.

Dependency manifest6pt100

Dependency manifest found (front/package.json).

Activity5pt100

Actively maintained (pushed within the last month).

Repository health signals

Activity, community, and responsiveness at scan time

Activity

  • —
    Commits (30d / 90d)
  • 15
    Forks
  • 15
    Releaseslatest 8mo ago

Community

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

Responsiveness

  • 3d 12h
    Median issue response
  • <1h
    Median PR merge time
  • 8
    Open issues
Repository files15 root entries
  • .github
    Good: CI is configured (.github/workflows/generate_swagger.yaml).
  • config
    Good: Environment pinned via config/grafana/Dockerfile.
    Issue: Build artifacts or local files may be committed (config/grafana/.env) (−40 pts).Fix: Remove them and add to .gitignore.
  • docs
  • front
    Good: Lockfile present (front/package-lock.json). Installs are reproducible.
    Good: Dependency manifest found (front/package.json).
  • java
    Good: Test files detected (java/mc-o11y-manager/src/test).
  • python
  • scripts
  • swagger
  • .gitignore
    Good: .gitignore present.
  • CODE_OF_CONDUCT.md
    Good: Code of conduct present.
  • CONTRIBUTING.md
    Issue: CONTRIBUTING guide is very brief (−12 pts for depth). 150+ words earns +6 pts; 400+ earns +12 pts.Fix: Add setup instructions, code style notes, and how to run tests.
    Issue: Contributing guide lacks a setup section (−12 pts).Fix: Show new contributors how to get a local dev environment running.
    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.
  • docker-compose.yaml
  • LICENSE
    Good: Licensed under Apache-2.0.
  • Makefile
  • 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.
    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.
    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.
    Good: README documents how to install the project.
    Good: README documents how to run the project.