ahmednafeaahmed/sample-cloud-native-toolchain-tutorial-20190612125815223

0

/ 100

Documentation50
Engineering47
Health70
JavaScript0MIT6y ago
Grade a repo

Rough and inactive. Tests, CI, and a fuller README would revive it.

Created for toolchain: https://console.bluemix.net/devops/toolchains/65825121-b38b-4252-97aa-615c881540f8?env_id=ibm%3Ayp%3Aus-south

Documentation

50

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.

Install and run instructions9pt45

README documents how to install the project.

README12pt50

README is present.

License6pt100

Licensed under MIT.

Engineering

47

CI/CD14pt0

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.

Reproducibility6pt0

No dependency lockfile found (−70 pts).

→ Commit package-lock.json, pnpm-lock.yaml, yarn.lock, or bun.lock so Node installs are repeatable.

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.

Tests18pt100

Test files detected (test).

Linting and formatting5pt100

Linter or formatter configured (lint script in package.json).

Project health

70

Activity5pt5

No pushes in over 2 years. Looks unmaintained (−95 pts).

→ A recent commit signals the project is alive and worth using.

Dependency manifest6pt83

Dependency manifest found (package.json).

Repository metadata5pt100

Repository has a description.

Housekeeping3pt100

.gitignore present.

Repository health signals

Activity, community, and responsiveness at scan time

Activity

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

Community

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

Responsiveness

  • —
    Median issue response
  • —
    Median PR merge time
  • 1
    Open issues
Repository files24 root entries
  • api
  • config
  • docs
  • public
  • routes
  • test
    Good: Test files detected (test).
  • tmp
  • views
  • .cfignore
  • .csignore
  • .gitignore
    Good: .gitignore present.
  • .jshintrc
  • app.js
  • bower.json
  • desireds.js
  • gruntfile.js
  • gulpfile.js
  • LICENSE
    Good: Licensed under MIT.
  • manifest.yml
  • newrelic.js
  • package.json
    Good: Dependency manifest found (package.json).
  • project.json
  • 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.
    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.
    Issue: No run or usage instructions found (−45 pts).Fix: Add a section showing how to start or use the project.
  • xunit.xml