ampl/mp

0

/ 100

Documentation30
Engineering49
Health100
C++250Other1d ago
Grade a repo

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

An open-source library for mathematical programming

Documentation

30

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.

README12pt30

README is present.

License6pt100

Licensed under Other.

Engineering

49

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/build-and-test.yaml).

Reproducibility6pt70

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

Tests18pt80

Test files detected (nl-writer2/nlwpy/test).

Project health

100

Dependency manifest6pt100

Dependency manifest found (doc/requirements.txt).

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)
  • 48
    Forks
  • 29
    Releaseslatest 11y ago

Community

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

Responsiveness

  • 18h
    Median issue response
  • 19h
    Median PR merge time
  • 83
    Open issues
Repository files22 root entries
  • .github
    Good: CI is configured (.github/workflows/build-and-test.yaml).
  • doc
    Good: Lockfile present (doc/requirements.txt). Installs are reproducible.
    Good: Dependency manifest found (doc/requirements.txt).
  • examples
  • include
  • nl-writer2
    Good: Test files detected (nl-writer2/nlwpy/test).
  • solvers
  • src
  • support
  • test
  • thirdparty
  • .gitattributes
  • .gitignore
    Good: .gitignore present.
  • .gitmodules
  • .readthedocs.yaml
  • .travis.yml
  • azure-pipelines.yml
  • CHANGES.mp.md
  • CMakeLists.txt
  • LICENSE.rst
    Good: Licensed under Other.
  • README.rst
    Good: README is present.
    Issue: README is fairly short (−10 pts). At 400+ chars you get partial credit; 1,500+ earns the full +20 pts.Fix: Expand with a description, install steps, usage, and examples.
    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.
    Issue: No run or usage instructions found (−45 pts).Fix: Add a section showing how to start or use the project.
  • try-local.sh
  • try.sh