xwiki/xwiki-commons
Grade a repo

0

/ 100

GradeC

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

Common Modules used by other XWiki top level projects

Documentation63
Engineering68
Health100
Java98LGPL-2.1today

Documentation

63

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.

README12pt85

README is present.

License6pt100

Licensed under LGPL-2.1.

Engineering

68

Reproducibility6pt0

No dependency lockfile found (−70 pts).

→ Commit the lockfile for this project's package manager so installs produce the same dependency versions everywhere.

CI/CD14pt57

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

Tests18pt80

Test files detected (xwiki-commons-core/xwiki-commons-blame/xwiki-commons-blame-api/src/test).

Linting and formatting5pt100

Java/Kotlin linting configured (xwiki-commons-tools/xwiki-commons-tool-verification-resources/src/main/resources/checkstyle.xml).

Issue and PR templates6pt100

Issue or PR templates present.

Project health

100

Dependency manifest6pt100

Dependency manifest found (pom.xml).

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

Community

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

Responsiveness

  • -
    Median issue response
  • 8h
    Median PR merge time
  • 42
    Open issues
Repository files14 root entries
  • .github
    Good: CI is configured (.github/workflows/backport.yml).
    Good: Issue or PR templates present.
  • .mvn
  • xwiki-commons-core
    Good: Test files detected (xwiki-commons-core/xwiki-commons-blame/xwiki-commons-blame-api/src/test).
  • xwiki-commons-pom
  • xwiki-commons-tools
    Good: Java/Kotlin linting configured (xwiki-commons-tools/xwiki-commons-tool-verification-resources/src/main/resources/checkstyle.xml).
  • .backportrc.json
  • .gitattributes
  • .gitignore
    Good: .gitignore present.
  • .lgtm.yml
  • Jenkinsfile
  • LICENSE
    Good: Licensed under LGPL-2.1.
  • pom.xml
    Good: Dependency manifest found (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.