xwiki/xwiki-platform
Grade a repo

0

/ 100

GradeD

Strong community interest, but tests, CI, or docs need work.

Top 48% of 5,156 graded repos

The XWiki platform

Documentation71
Engineering60
Health86
Java1,277LGPL-2.11mo ago

A low grade is a to-do list, not a judgment of your code

Most gaps here are documentation, tests, and setup, not the code itself. Closing your top 3 gaps alone would lift this repo to B (88).

See your top fixes
Now
D
68
Potential
B
88

Top fixes

Highest-impact changes first, ranked by point weight

21 to address
  1. 1
    Tests18pt

    Set scripts.test in package.json to your actual test command, e.g. "vitest" or "jest".

  2. 2
    CI/CD14pt

    Add a step like `run: npm test`, `run: pytest`, or `run: tox` to your workflow file.

  3. 3
    CI/CD14pt

    Add a lint step to catch style issues automatically.

  4. 4
    CI/CD14pt

    Upload coverage to Codecov, Coveralls, or report it with `--coverage` flags.

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

71

Install and run instructions9pt45

README documents how to install the project.

Contributing guide5pt47

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.

README12pt85

README is present.

License6pt100

Licensed under LGPL-2.1.

Engineering

60

Tests18pt35

Test files detected (xwiki-platform-core/xwiki-platform-activeinstalls2/xwiki-platform-activeinstalls2-api/src/test).

CI/CD14pt57

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

Reproducibility6pt70

Lockfile present (pnpm-lock.yaml). Installs are reproducible.

Linting and formatting5pt100

Linter or formatter configured (xwiki-platform-core/xwiki-platform-blocknote/xwiki-platform-blocknote-webjar/src/main/node/eslint.config.mjs).

Issue and PR templates6pt100

Issue or PR templates present.

Project health

86

Dependency manifest6pt55

Dependency manifest found (package.json).

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)
  • 648
    Forks
  • 74
    Releaseslatest 1y ago

Community

  • -
    Community health
  • -
    authors own >50% of commits
  • 1,277
    Watchers

Responsiveness

  • -
    Median issue response
  • 20h
    Median PR merge time
  • 216
    Open issues
Repository files20 root entries
  • .github
    Good: CI is configured (.github/workflows/backport.yml).
    Good: Issue or PR templates present.
  • .mvn
  • xwiki-platform-core
    Good: Test files detected (xwiki-platform-core/xwiki-platform-activeinstalls2/xwiki-platform-activeinstalls2-api/src/test).
    Good: Linter or formatter configured (xwiki-platform-core/xwiki-platform-blocknote/xwiki-platform-blocknote-webjar/src/main/node/eslint.config.mjs).
  • xwiki-platform-distribution
  • xwiki-platform-tools
  • .backportrc.json
  • .gitattributes
  • .gitignore
    Good: .gitignore present.
  • .lgtm.yml
  • 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.
  • Jenkinsfile
  • JenkinsfileEnvironmentTests
  • LICENSE
    Good: Licensed under LGPL-2.1.
  • nx.json
  • package.json
    Good: Dependency manifest found (package.json).
  • pnpm-lock.yaml
    Good: Lockfile present (pnpm-lock.yaml). Installs are reproducible.
  • pnpm-workspace.yaml
  • pom.xml
  • 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.
    Good: README includes status badges.
    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.
  • SECURITY.md
    Good: Security policy present.
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/xwiki/xwiki-platform)](https://www.repo-grade.com/report/xwiki/xwiki-platform)

More graded Java repos