sciml/nonlinearsolve.jl

0

/ 100

Documentation56
Engineering47
Health68
Julia299MIT1d ago
Grade a repo

Popular for its size, but the engineering basics lag behind the interest.

High-performance and differentiation-enabled nonlinear solvers (Newton methods), bracketed rootfinding (bisection, Falsi), with sparsity and Newton-Krylov support.

Documentation

56

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.

README12pt100

README is present.

License6pt100

Licensed under MIT.

Engineering

47

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.

Reproducibility6pt12

No dependency lockfile found (−70 pts).

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

CI/CD14pt57

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

Tests18pt80

Test files detected (lib/BracketingNonlinearSolve/test).

Project health

68

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.

Repository metadata5pt100

Repository has a description.

Activity5pt100

Actively maintained (pushed within the last month).

Housekeeping3pt100

.gitignore present.

Repository health signals

Activity, community, and responsiveness at scan time

Activity

  • —
    Commits (30d / 90d)
  • 70
    Forks
  • 342
    Releaseslatest 5y ago

Community

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

Responsiveness

  • 5h
    Median issue response
  • 6h
    Median PR merge time
  • 70
    Open issues
Repository files14 root entries
  • .github
    Good: CI is configured (.github/workflows/CI_NonlinearSolve.yml).
    Good: Dependabot configured for github-actions.
  • common
  • docs
  • ext
  • lib
    Good: Test files detected (lib/BracketingNonlinearSolve/test).
  • src
  • test
  • .codecov.yml
  • .gitignore
    Good: .gitignore present.
  • .typos.toml
  • CITATION.cff
  • LICENSE.md
    Good: Licensed under MIT.
  • Project.toml
  • README.md
    Good: README is present.
    Good: README is well structured with multiple sections.
    Good: README includes screenshots or visuals. Great for first impressions.
    Good: README has code examples.
    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.
    Issue: No run or usage instructions found (−45 pts).Fix: Add a section showing how to start or use the project.