aabhinavg1/compilersutra

0

/ 100

Documentation39
Engineering25
Health78
JavaScript13MIT3d ago
Grade a repo

Some interest. A stronger README and CI would help.

Documentation

39

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.

README12pt55

README is present.

License6pt100

Licensed under MIT.

Engineering

25

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.

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/CD14pt57

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

Reproducibility6pt70

Lockfile present (package-lock.json). Installs are reproducible.

Project health

78

Repository metadata5pt40

No repository description set on GitHub (−60 pts).

→ Add a one-line description in the repo Settings → About. It appears in search results and social previews.

Housekeeping3pt60

.gitignore present.

Dependency manifest6pt100

Dependency manifest found (package.json).

Activity5pt100

Actively maintained (pushed within the last month).

Repository files30 root entries
  • .ci
  • .github
    Good: CI is configured (.github/workflows/build_and_notify.yml).
  • docs
  • examples
  • scripts
    Issue: Build artifacts or local files may be committed (scripts/__pycache__/generate_favicon_assets.cpython-312.pyc) (−40 pts).Fix: Remove them and add to .gitignore.
  • sidebars
  • src
  • static
  • .gitignore
    Good: .gitignore present.
  • abhi
  • babel.config.js
  • Contribution.md
  • disable_llvm_pass.md
  • docusaurus.config.js
  • emails.txt
  • funding.json
  • google39b7985eff296b7a.html
  • LICENSE.md
    Good: Licensed under MIT.
  • netlify.toml
  • package-lock.json
    Good: Lockfile present (package-lock.json). Installs are reproducible.
  • package.json
    Good: Dependency manifest found (package.json).
  • prebuild.js
  • 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.
    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.
  • sidebars.js
  • simple_pressure-host-x86_64-unknown-linux-gnu.hipi
  • simple_pressure.hip-hip-amdgcn-amd-amdhsa.hipfb
  • stackbit.config.ts
  • tags.xml
  • vercel.json
  • webpack.config.js