jinjiawu/p3c

0

/ 100

Kotlin0Apache-2.08y ago
Grade a repo

Lots of room to improve. Start with a README and CI.

Alibaba Java Coding Guidelines pmd implements and IDE plugin

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

No install instructions found in the README (−45 pts).

Add a section showing how to install dependencies.

README12pt85

README is present.

License6pt100

Licensed under Apache-2.0.

Engineering

29

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.

Linting and formatting5pt0

No Java/Kotlin linter configured.

Add Checkstyle or Spotless for Java formatting, or ktlint/Detekt for Kotlin. Run it via Maven/Gradle or as a CI step.

Reproducibility6pt0

No dependency lockfile found (−70 pts).

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

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 (p3c-pmd/src/test).

Project health

75

Activity5pt5

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

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

Dependency manifest6pt100

Dependency manifest found (eclipse-plugin/com.alibaba.smartfox.eclipse.feature/pom.xml).

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
  • 0
    Open issues
Repository files7 root entries
  • eclipse-plugin
    Good: Dependency manifest found (eclipse-plugin/com.alibaba.smartfox.eclipse.feature/pom.xml).
  • idea-plugin
  • p3c-pmd
    Good: Test files detected (p3c-pmd/src/test).
  • .gitignore
    Good: .gitignore present.
  • license.txt
    Good: Licensed under Apache-2.0.
  • 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.
    Issue: No install instructions found in the README (−45 pts).Fix: Add a section showing how to install dependencies.
    Good: README documents how to run the project.
  • 阿里巴巴Java开发手册(终极版).pdf