markusproject/markus

0

/ 100

Documentation60
Engineering88
Health94
Ruby282MIT1d ago
Grade a repo

Good shape overall. A few tweaks would push it into the top tier.

Git repository of MarkUs

Documentation

60

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.

README12pt75

README is present.

License6pt100

Licensed under MIT.

Engineering

88

Tests18pt80

Test files detected (app/javascript/Components/__tests__).

CI/CD14pt85

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

Linting and formatting5pt100

Ruby linting configured (.editorconfig).

Reproducibility6pt100

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

Issue and PR templates6pt100

Issue or PR templates present.

Project health

94

Housekeeping3pt60

.gitignore present.

Dependency manifest6pt100

Dependency manifest found (Gemfile).

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)
  • 258
    Forks
  • 93
    Releaseslatest 5y ago

Community

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

Responsiveness

  • 115d 1h
    Median issue response
  • <1h
    Median PR merge time
  • 104
    Open issues
Repository files53 root entries
  • .dockerfiles
    Good: Environment pinned via .dockerfiles/Dockerfile.
    Issue: Build artifacts or local files may be committed (.dockerfiles/.env) (−40 pts).Fix: Remove them and add to .gitignore.
  • .github
    Good: CI is configured (.github/workflows/test_ci.yml).
    Good: Dependabot covers 4 ecosystems (github-actions, bundler, npm, pip). Dependencies stay current.
    Good: Issue or PR templates present.
  • app
    Good: Test files detected (app/javascript/Components/__tests__).
  • bin
  • config
  • db
  • doc
  • lib
  • public
  • release
  • spec
  • vendor
  • .active_record_doctor.rb
  • .annotaterb.yml
  • .dockerignore
  • .editorconfig
    Good: Ruby linting configured (.editorconfig).
  • .erb_lint.yml
  • .git-blame-ignore-revs
  • .gitignore
    Good: .gitignore present.
  • .pre-commit-config.yaml
  • .prettierignore
  • .prettierrc.yml
  • .rspec
  • .rspec_parallel
  • .rubocop.yml
  • .stylelintrc.yaml
  • .yarnrc.yml
  • babel.config.js
  • Changelog.md
  • compose-prod.yaml
  • compose.yaml
  • config.ru
  • Gemfile
    Good: Dependency manifest found (Gemfile).
  • Gemfile.lock
    Good: Lockfile present (Gemfile.lock). Installs are reproducible.
  • INSTALL
  • jest_after_env_setup.js
  • jest_env_setup.js
  • jest.config.js
  • LICENSE
    Good: Licensed under MIT.
  • markus_1.0_all.deb
  • markus.control
  • package-lock.json
  • package.json
  • postcss.config.js
  • Rakefile
  • 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.
    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.
  • requirements-jupyter.txt
  • requirements-scanner.txt
  • SECURITY.md
    Good: Security policy present.
  • Vagrantfile
  • webpack.common.js
  • webpack.development.js
  • webpack.production.js