permissionlesstech/bitchat

0

/ 100

Documentation58
Engineering62
Health100
Swift26,036Unlicense5d ago
Grade a repo

Strong community interest, but docs and engineering haven't caught up to the hype.

bluetooth mesh chat, IRC vibes

Documentation

58

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.

README12pt70

README is present.

License6pt100

Licensed under Unlicense.

Engineering

62

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 (localPackages/Arti/Cargo.lock). Installs are reproducible.

Tests18pt80

Test files detected (bitchatTests/AppArchitectureTests.swift).

CI/CD14pt85

CI is configured (.github/workflows/swift-tests.yml).

Project health

100

Dependency manifest6pt100

Dependency manifest found (Package.swift).

Repository metadata5pt100

Repository has a description.

Activity5pt100

Actively maintained (pushed within the last month).

Housekeeping3pt100

.gitignore present.

Repository files20 root entries
  • .github
    Good: CI is configured (.github/workflows/swift-tests.yml).
  • bitchat
  • bitchat.xcodeproj
  • bitchatShareExtension
  • bitchatTests
    Good: Test files detected (bitchatTests/AppArchitectureTests.swift).
  • Configs
  • docs
  • localPackages
    Good: Lockfile present (localPackages/Arti/Cargo.lock). Installs are reproducible.
  • relays
  • scripts
  • .gitattributes
  • .gitignore
    Good: .gitignore present.
  • BRING_THE_NOISE.md
  • Justfile
  • LICENSE
    Good: Licensed under Unlicense.
  • Package.resolved
  • Package.swift
    Good: Dependency manifest found (Package.swift).
  • PRIVACY_POLICY.md
  • README.md
    Good: README is present.
    Good: README is well structured with multiple sections.
    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.
    Good: README has code examples.
    Good: README links to a live demo or deployed app.
    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.
    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.
  • WHITEPAPER.md