particify/arsnova-server
Grade a repo

0

/ 100

GradeC

Solid foundation. Invest in docs and CI to grow from here.

Top 43% of 5,156 graded repos

The backend components of ARSnova. ARSnova is a modern, web-based approach to Audience Response Systems (ARS).

Documentation46
Engineering78
Health100
Java61GPL-3.01mo ago

Top fixes

Highest-impact changes first, ranked by point weight

12 to address
  1. 1
    Tests18pt

    Wire your tests to a documented command (e.g. a test script in your build config) so the suite is reproducible.

  2. 2
    README12pt

    Break it into sections (Overview, Install, Usage, Contributing) using Markdown headings.

  3. 3
    README12pt

    Add a GIF, screenshot, or logo image. It is the fastest way to show what your project does.

  4. 4
    README12pt

    Show a quick-start snippet so contributors can see what using your project looks like.

Working through the fixes? Let every push regrade itself.

The free GitHub App rescans this repo on every push and posts the grade as a commit check, so the score climbs without coming back to rescan by hand.

Install the GitHub App

Scorecard

Every check, grouped by category and sorted worst-first

Documentation

46

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.

README12pt40

README is present.

Install and run instructions9pt45

README documents how to install the project.

License6pt100

Licensed under GPL-3.0.

Engineering

78

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.

Tests18pt80

Test files detected (authz/src/test).

Reproducibility6pt80

Lockfile present (formatting/yarn.lock). Installs are reproducible.

CI/CD14pt100

CI is configured (.docker/images/.gitlab-ci.yml).

Linting and formatting5pt100

Java/Kotlin linting configured (.editorconfig).

Project health

100

Dependency manifest6pt100

Dependency manifest found (build.gradle.kts).

Repository metadata5pt100

Repository has a description.

Activity5pt100

Actively maintained (pushed within the last month).

Housekeeping3pt100

.gitignore present.

Repository health signals

Activity, community, and responsiveness at scan time

Activity

  • -
    Commits (30d / 90d)
  • 44
    Forks
  • 60
    Releaseslatest 10y ago

Community

  • -
    Community health
  • -
    authors own >50% of commits
  • 61
    Watchers

Responsiveness

  • -
    Median issue response
  • 9h
    Median PR merge time
  • 0
    Open issues
Repository files29 root entries
  • .docker
    Good: CI is configured (.docker/images/.gitlab-ci.yml).
    Good: Environment pinned via .docker/images/couchdb/Dockerfile.
    Good: .gitignore present.
  • .gitlab
  • authz
    Good: Test files detected (authz/src/test).
  • comments
  • common
  • core
    Good: Licensed under GPL-3.0.
  • core4
  • docs
  • formatting
    Good: Lockfile present (formatting/yarn.lock). Installs are reproducible.
  • gradle
  • platform
  • websocket
  • .editorconfig
    Good: Java/Kotlin linting configured (.editorconfig).
  • .git-blame-ignore-revs
  • .gitignore
  • .gitlab-ci.yml
  • .gitmodules
  • .npmrc
  • .pre-commit-config.yaml
  • .renovaterc.json
  • build.gradle.kts
    Good: Dependency manifest found (build.gradle.kts).
  • gradle.properties
  • gradlew
  • gradlew.bat
  • pdk
  • README.adoc
    Good: README is present.
    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.
    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.
  • settings.gradle.kts
  • spotbugs-exclude.xml
  • webclient
RepoGrade badge preview

Add this badge to your README

It updates automatically each time the repo is re-graded.

[![RepoGrade](https://www.repo-grade.com/api/badge/particify/arsnova-server)](https://www.repo-grade.com/report/particify/arsnova-server)

More graded Java repos