gaggle/elixir_script

0

/ 100

Documentation45
Engineering50
Health46
Elixir4MIT7mo ago
Grade a repo

Lots of room to improve. Start with a README and CI.

Run Elixir code in workflow steps

Documentation

45

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.

README12pt70

README is present.

License6pt100

Licensed under MIT.

Engineering

50

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.

Reproducibility6pt10

No dependency lockfile found (−70 pts).

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

CI/CD14pt68

CI is configured (.github/workflows/ci-cd.yml).

Tests18pt80

Test files detected (test).

Project health

46

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.

Activity5pt40

Last pushed 6-12 months ago (−60 pts).

→ A recent commit signals the project is still maintained.

Housekeeping3pt60

.gitignore present.

Repository metadata5pt100

Repository has a description.

Repository files16 root entries
  • .github
    Good: CI is configured (.github/workflows/ci-cd.yml).
    Good: Environment pinned via .github/Dockerfile.
  • .idea
    Issue: Build artifacts or local files may be committed (.idea/.gitignore) (−40 pts).Fix: Remove them and add to .gitignore.
  • bin
  • config
  • lib
  • test
    Good: Test files detected (test).
  • .dockerignore
  • .formatter.exs
  • .gitignore
    Good: .gitignore present.
  • .pkgx.yaml
  • action.yml
  • elixir_script.iml
  • LICENSE
    Good: Licensed under MIT.
  • mix.exs
  • mix.lock
  • README.md
    Good: README is present.
    Good: README is well structured with multiple sections.
    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.
    Good: README has code examples.
    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.