0
/ 100
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?
A low grade is a to-do list, not a judgment of your code
Most gaps here are documentation, tests, and setup, not the code itself. Closing your top 3 gaps alone would lift this repo to C (74).
See your top fixesTop fixes
Highest-impact changes first, ranked by point weight
- 1Tests18pt
Add automated tests. They prove the code works and give contributors confidence to make changes.
- 2README12pt
Show a quick-start snippet so contributors can see what using your project looks like.
- 3README12pt
Add CI/build status badges from shields.io or your CI provider to signal project health.
- 4Install and run instructions9pt
Add a section showing how to install dependencies.
Working through the fixes? Let every push regrade itself.
The free GitHub App rescans this repo on every push and posts the grade as a commit check, so the score climbs without coming back to rescan by hand.
Scorecard
Every check, grouped by category and sorted worst-first
Documentation
32
No install instructions found in the README (−45 pts).
→ Add a section showing how to install dependencies.
No license detected.
→ Add a LICENSE file. Without one, nobody can legally use, copy, or contribute to your code.
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.
README is present.
Engineering
39
No tests detected anywhere in the repository.
→ Add automated tests. They prove the code works and give contributors confidence to make changes.
No dependency lockfile found (−70 pts).
→ Commit Gemfile.lock so Bundler installs are repeatable.
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 is configured (.travis.yml).
Ruby linting configured (.editorconfig).
Project health
75
No pushes in over 2 years. Looks unmaintained (−95 pts).
→ A recent commit signals the project is alive and worth using.
Dependency manifest found (Gemfile).
Repository has a description.
.gitignore present.
Repository files15 root entries
- .themes
- plugins
- _config.yml
- .editorconfigGood: Ruby linting configured (.editorconfig).
- .gitattributes
- .gitignoreGood: .gitignore present.
- .powrc
- .slugignore
- .travis.ymlGood: CI is configured (.travis.yml).
- CHANGELOG.markdown
- config.rb
- config.ru
- GemfileGood: Dependency manifest found (Gemfile).
- Rakefile
- README.markdownGood: 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.
Add this badge to your README
It updates automatically each time the repo is re-graded.
[](https://www.repo-grade.com/report/imathis/octopress)