sswconsulting/ssw.rules.content

0

/ 100

Documentation47
Engineering40
Health94
MDX58CC0-1.01d ago
Grade a repo

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

Secret ingredients to quality software

Documentation

47

Install and run instructions9pt0

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

→ Add a section showing how to install dependencies.

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.

README12pt75

README is present.

License6pt100

Licensed under CC0-1.0.

Engineering

40

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.

CI/CD14pt57

CI is configured (.github/workflows/check-category-sync.yml).

Reproducibility6pt90

Lockfile present (scripts/category-sync-validator/package-lock.json). Installs are reproducible.

Issue and PR templates6pt100

Issue or PR templates present.

Project health

94

Housekeeping3pt60

.gitignore present.

Dependency manifest6pt100

Dependency manifest found (scripts/FindFixRules/FindFixRules.csproj).

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)
  • 194
    Forks
  • 0
    Releases

Community

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

Responsiveness

  • 1d 19h
    Median issue response
  • <1h
    Median PR merge time
  • 65
    Open issues
Repository files20 root entries
  • _docs
  • .claude
  • .github
    Good: CI is configured (.github/workflows/check-category-sync.yml).
    Good: Dependabot covers 2 ecosystems (github-actions, npm). Dependencies stay current.
    Good: Issue or PR templates present.
  • .markdownlint
  • .workflow
  • assets
  • categories
  • global
  • homepage
  • public
  • scripts
    Good: Lockfile present (scripts/category-sync-validator/package-lock.json). Installs are reproducible.
    Good: Dependency manifest found (scripts/FindFixRules/FindFixRules.csproj).
    Issue: Build artifacts or local files may be committed (scripts/tina-migration/__pycache__/convert-rule-md-to-mdx.cpython-310.pyc) (−40 pts).Fix: Remove them and add to .gitignore.
  • template
  • .contenthawk-version
  • .gitattributes
  • .gitignore
    Good: .gitignore present.
  • AGENTS.md
  • CLAUDE.md
  • history.json
  • LICENSE
    Good: Licensed under CC0-1.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.
    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.
    Issue: No run or usage instructions found (−45 pts).Fix: Add a section showing how to start or use the project.