casualtek/cyberwatch
Grade a repo

0

/ 100

GradeF

Some interest. A stronger README and CI would help.

Building a consolidated RSS feed for articles about cyberattacks

Documentation46
Engineering20
Health91
HTML74Othertoday

Documentation

46

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.

README12pt40

README is present.

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

20

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 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.

CI/CD14pt40

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

Reproducibility6pt70

Lockfile present (requirements.txt). Installs are reproducible.

Project health

91

Housekeeping3pt40

No .gitignore found (−60 pts).

→ Add a .gitignore to keep build output, node_modules, and secrets out of version control.

Dependency manifest6pt100

Dependency manifest found (requirements.txt).

Repository metadata5pt100

Repository has a description.

Activity5pt100

Actively maintained (pushed within the last month).

Repository health signals

Activity, community, and responsiveness at scan time

Activity

  • -
    Commits (30d / 90d)
  • 19
    Forks
  • 0
    Releases

Community

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

Responsiveness

  • <1h
    Median issue response
  • -
    Median PR merge time
  • 6
    Open issues
Repository files33 root entries
  • .github
    Good: CI is configured (.github/workflows/check_twse.yml).
  • cyberhebdo
  • meteocyber
  • states
  • assess-lb-09052024.json
  • assessments.json
  • breach_monitor_requirements.txt
  • breach_monitor.py
  • cleanup.py
  • cyberattacks_news.xml
  • cyberattacks-feed.py
  • cyberattacks.json
  • cyberattaques.xml
  • domain_discovery.py
  • extract_pdf.py
  • inventory.json
  • LICENSE.md
    Good: Licensed under Other.
  • notify_assessed.py
  • notify_requirements.txt
  • notify.py
  • README.md
    Good: README is present.
    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.
    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.
    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.
  • requirements.txt
    Good: Lockfile present (requirements.txt). Installs are reproducible.
    Good: Dependency manifest found (requirements.txt).
  • review-week-de-legacy.py
  • review-week-de.py
  • review-week-legacy.py
  • review-week.py
  • rss_requirements.txt
  • rss-legagy.py
  • rss.py
  • seen_items.txt
  • twse_requirements.txt
  • twse.py
  • unlikely_cyberattacks_news.xml