oxasploits/packetsnitch

0

/ 100

Documentation76
Engineering28
Health85
JavaScript11GPL-3.03d ago
Grade a repo

Getting some notice. Tests and CI would be the fastest wins.

PacketSnitch is a high level network capture analysis, packet decoding tool

Documentation

76

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.

README12pt85

README is present.

Install and run instructions9pt90

README documents how to install the project.

License6pt100

Licensed under GPL-3.0.

Engineering

28

Tests18pt0

No tests detected anywhere in the repository.

→ Add automated tests. They prove the code works and give contributors confidence to make changes.

Linting and formatting5pt0

No linter or formatter found.

→ Add ESLint (eslint.config.js) and/or Prettier (.prettierrc), install them as devDependencies, and add a `lint` script to package.json.

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.

CI/CD14pt68

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

Reproducibility6pt70

Lockfile present (package-lock.json). Installs are reproducible.

Project health

85

Housekeeping3pt60

.gitignore present.

Dependency manifest6pt73

Dependency manifest found (package.json).

Repository metadata5pt100

Repository has a description.

Activity5pt100

Actively maintained (pushed within the last month).

Repository files22 root entries
  • .github
    Good: CI is configured (.github/workflows/repostats.yml).
  • .vscode
  • dist
  • docs
  • ideas
  • logo
  • patches
  • samples
  • src
    Issue: Build artifacts or local files may be committed (src/backend/__pycache__/snitch.cpython-312.pyc) (−40 pts).Fix: Remove them and add to .gitignore.
  • .gitignore
    Good: .gitignore present.
  • desktop.ejs
  • forge.config.js
  • LICENSE.md
    Good: Licensed under GPL-3.0.
  • package-lock.json
    Good: Lockfile present (package-lock.json). Installs are reproducible.
  • package.json
    Good: Dependency manifest found (package.json).
  • 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.
    Good: README documents how to run the project.
  • snitch.spec
  • webpack.main.config.js
  • webpack.plugins.js
  • webpack.preload.config.js
  • webpack.renderer.config.js
  • webpack.rules.js