imathis/octopress

0

/ 100

Documentation32
Engineering39
Health75
Ruby9,2412y ago
Grade a repo

Real traction, but rough engineering makes it hard for contributors to trust.

Octopress is an obsessively designed framework for Jekyll blogging. It’s easy to configure and easy to deploy. Sweet huh?

Documentation

32

Install and run instructions9pt0

No install instructions found in the README (−45 pts).

→ Add a section showing how to install dependencies.

License6pt0

No license detected.

→ Add a LICENSE file. Without one, nobody can legally use, copy, or contribute to your code.

Contributing guide5pt25

Contributing guidance is in the README, not a dedicated CONTRIBUTING.md (−20 pts).

→ Moving it to a CONTRIBUTING.md makes it easier to find and keeps the README focused. A dedicated file earns +47 pts base.

README12pt75

README is present.

Engineering

39

Tests18pt0

No tests detected anywhere in the repository.

→ Add automated tests. They prove the code works and give contributors confidence to make changes.

Reproducibility6pt0

No dependency lockfile found (−70 pts).

→ Commit Gemfile.lock so Bundler installs are repeatable.

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

CI is configured (.travis.yml).

Linting and formatting5pt100

Ruby linting configured (.editorconfig).

Project health

75

Activity5pt5

No pushes in over 2 years. Looks unmaintained (−95 pts).

→ A recent commit signals the project is alive and worth using.

Dependency manifest6pt100

Dependency manifest found (Gemfile).

Repository metadata5pt100

Repository has a description.

Housekeeping3pt100

.gitignore present.

Repository files15 root entries
  • .themes
  • plugins
  • _config.yml
  • .editorconfig
    Good: Ruby linting configured (.editorconfig).
  • .gitattributes
  • .gitignore
    Good: .gitignore present.
  • .powrc
  • .slugignore
  • .travis.yml
    Good: CI is configured (.travis.yml).
  • CHANGELOG.markdown
  • config.rb
  • config.ru
  • Gemfile
    Good: Dependency manifest found (Gemfile).
  • Rakefile
  • README.markdown
    Good: README is present.
    Good: README is well structured with multiple sections.
    Good: README includes screenshots or visuals. Great for first impressions.
    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.