argotorg/solidity

0

/ 100

Documentation70
Engineering78
Health94
C++25,662GPL-3.06d ago
Grade a repo

Popular and well-maintained. A little polish away from elite status.

Solidity, the Smart Contract Programming Language

Documentation

70

Install and run instructions9pt45

README documents how to install the project.

Contributing guide5pt52

CONTRIBUTING guide is very brief (−12 pts for depth). 150+ words earns +6 pts; 400+ earns +12 pts.

→ Add setup instructions, code style notes, and how to run tests.

README12pt80

README is present.

License6pt100

Licensed under GPL-3.0.

Engineering

78

CI/CD14pt57

CI is configured (.github/workflows/buildpack-deps.yml).

Tests18pt80

Test files detected (scripts/externalTests/test_helpers.py).

Reproducibility6pt80

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

Linting and formatting5pt100

Linter or formatter configured (.editorconfig).

Issue and PR templates6pt100

Issue or PR templates present.

Project health

94

Housekeeping3pt60

.gitignore present.

Dependency manifest6pt100

Dependency manifest found (docs/requirements.txt).

Repository metadata5pt100

Repository has a description.

Activity5pt100

Actively maintained (pushed within the last month).

Repository files37 root entries
  • .circleci
  • .github
    Good: CI is configured (.github/workflows/buildpack-deps.yml).
    Good: Issue or PR templates present.
  • cmake
  • deps
  • docs
    Good: Lockfile present (docs/requirements.txt). Installs are reproducible.
    Good: Dependency manifest found (docs/requirements.txt).
  • libevmasm
  • liblangutil
  • libsmtutil
  • libsolc
  • libsolidity
  • libsolutil
  • libstdlib
  • libyul
  • scripts
    Good: Test files detected (scripts/externalTests/test_helpers.py).
    Good: Environment pinned via scripts/Dockerfile.
  • snap
  • solc
  • test
    Issue: Build artifacts or local files may be committed (test/libsolidity/lsp/node_modules/my-module) (−40 pts).Fix: Remove them and add to .gitignore.
  • tools
  • .clang-format
  • .codespellrc
  • .dockerignore
  • .editorconfig
    Good: Linter or formatter configured (.editorconfig).
  • .gitattributes
  • .gitignore
    Good: .gitignore present.
  • .gitmodules
  • .readthedocs.yml
  • Changelog.md
  • CMakeLists.txt
  • CODE_OF_CONDUCT.md
    Good: Code of conduct present.
  • CODING_STYLE.md
  • CONTRIBUTING.md
    Issue: CONTRIBUTING guide is very brief (−12 pts for depth). 150+ words earns +6 pts; 400+ earns +12 pts.Fix: Add setup instructions, code style notes, and how to run tests.
    Issue: Contributing guide lacks a setup section (−12 pts).Fix: Show new contributors how to get a local dev environment running.
    Issue: Contributing guide lacks a code style section (−8 pts).Fix: Describe your linting/formatting rules and how to run them.
    Issue: Contributing guide lacks a testing section (−8 pts).Fix: Show contributors how to run the test suite (e.g. npm test, pytest, cargo test).
    Issue: Contributing guide lacks a PR workflow section (−8 pts).Fix: Explain how to fork, branch, and open a pull request so contributors know what to expect.
    Issue: Contributing guide has no code examples (−5 pts).Fix: Add code blocks showing example commands for setup, running tests, and submitting a PR.
  • funding.json
  • LICENSE.txt
    Good: Licensed under GPL-3.0.
  • 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.
    Good: README includes status badges.
    Good: README documents how to install the project.
    Issue: No run or usage instructions found (−45 pts).Fix: Add a section showing how to start or use the project.
  • ReleaseChecklist.md
  • ReviewChecklist.md
  • SECURITY.md
    Good: Security policy present.