kevios12/kernel_oneplus_sm8150

0

/ 100

Documentation35
Engineering38
Health64
0Other3y ago
Grade a repo

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

!!! BACKUP !!!

Documentation

35

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.

README12pt10

This repository is large enough that GitHub truncated the file tree. The scan is based on a partial file list, so some checks may under-report.

Install and run instructions9pt45

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

→ Add a section showing how to install dependencies.

License6pt100

Licensed under Other.

Engineering

38

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 linter or formatter config found.

→ Add a linter config such as .eslintrc.json, .prettierrc, ruff.toml, or .golangci.yml to enforce consistent code style.

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.

Reproducibility6pt70

Lockfile present (Documentation/sphinx/requirements.txt). Installs are reproducible.

Tests18pt80

Test files detected (coretech/control_center/test).

Project health

64

Activity5pt5

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

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

Repository metadata5pt60

Repository has a description.

Dependency manifest6pt100

Dependency manifest found (Documentation/sphinx/requirements.txt).

Housekeeping3pt100

.gitignore present.

Repository health signals

Activity, community, and responsiveness at scan time

Activity

  • —
    Commits (30d / 90d)
  • 0
    Forks
  • —
    Releases

Community

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

Responsiveness

  • —
    Median issue response
  • —
    Median PR merge time
  • 0
    Open issues
Repository files53 root entries
  • arch
  • block
  • certs
  • coretech
    Good: Test files detected (coretech/control_center/test).
  • crypto
  • Documentation
    Good: Licensed under Other.
    Good: Lockfile present (Documentation/sphinx/requirements.txt). Installs are reproducible.
    Good: Dependency manifest found (Documentation/sphinx/requirements.txt).
  • drivers
  • firmware
  • fs
  • include
  • init
  • ipc
  • kernel
  • lib
  • mm
  • net
  • opslalib
  • samples
  • scripts
  • security
  • sound
  • techpack
  • tools
  • .cocciconfig
  • .get_maintainer.ignore
  • .gitattributes
  • .gitignore
    Good: .gitignore present.
  • .mailmap
  • Android.mk
  • Androidbp
  • AndroidKernel.mk
  • build.config.aarch64
  • build.config.common
  • build.config.cuttlefish.aarch64
  • build.config.cuttlefish.x86_64
  • build.config.goldfish.arm
  • build.config.goldfish.arm64
  • build.config.goldfish.mips
  • build.config.goldfish.mips64
  • build.config.goldfish.x86
  • build.config.goldfish.x86_64
  • build.config.x86_64
  • COPYING
  • CREDITS
  • disable_dbgfs.sh
  • gen_headers_arm.bp
  • gen_headers_arm64.bp
  • Kbuild
  • Kconfig
  • kernel_headers.py
  • MAINTAINERS
  • Makefile
  • README
    Good: README is present.
    Issue: README is fairly short (−10 pts). At 400+ chars you get partial credit; 1,500+ earns the full +20 pts.Fix: Expand with a description, install steps, usage, and examples.
    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.
    Issue: No live demo link in the README (−20 pts).Fix: Link to a deployed version, docs site, or demo video. Users want to see it running.
    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.
    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.