mritchielab/long_read_tools

0

/ 100

Documentation67
Engineering41
Health62
JavaScript89MIT1d ago
Grade a repo

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

A catalogue of available long read sequencing data analysis tools

Documentation

67

Contributing guide5pt25

Contributing guidance is in the README, not a dedicated CONTRIBUTING.md (−20 pts).

→ Moving it to a CONTRIBUTING.md makes it easier to find and keeps the README focused. A dedicated file earns +47 pts base.

Install and run instructions9pt45

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

→ Add a section showing how to install dependencies.

README12pt85

README is present.

License6pt100

Licensed under MIT.

Engineering

41

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.

Reproducibility6pt0

No dependency lockfile found (−70 pts).

→ Commit the lockfile for this project's package manager so installs produce the same dependency versions everywhere.

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/automated_tool_search.yml).

Tests18pt80

Test files detected (docs/test_server.py).

Project health

62

Dependency manifest6pt0

No dependency manifest detected at root.

→ Add a manifest (package.json, pyproject.toml, Cargo.toml, go.mod, etc.) so others can install dependencies in one command.

Housekeeping3pt60

.gitignore present.

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
  • 89
    Watchers

Responsiveness

  • 21d 16h
    Median issue response
  • 1h
    Median PR merge time
  • 1
    Open issues
Repository files25 root entries
  • .github
    Good: CI is configured (.github/workflows/automated_tool_search.yml).
  • docs
    Good: Test files detected (docs/test_server.py).
  • libraries
  • R
  • .DS_Store
    Issue: Build artifacts or local files may be committed (.DS_Store) (−40 pts).Fix: Remove them and add to .gitignore.
  • .gitattributes
  • .gitignore
    Good: .gitignore present.
  • append_script.py
  • benchmark_studies.csv
  • build_lrs_db.R
  • generate_pr_message.py
  • LICENSE
    Good: Licensed under MIT.
  • long_read_tools_master.csv
  • long_read_tools.Rproj
  • lrdb_contribution
  • lrdb_contribution.md
  • new_submission_check.R
  • new_submissions_conflicts.csv
  • new_submissions_no_conflicts.csv
  • new_submissions.csv
  • new_tools.csv
  • PULL_REQUEST_TEMPLATE.md
  • 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.
    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.
  • robots.txt
  • search_tools.py