kilimchoi/engineering-blogs

0

/ 100

Documentation69
Engineering26
Health73
Ruby38,3161y ago
Grade a repo

Huge star count, but README, tests, and CI need real investment.

A curated list of engineering blogs

Documentation

69

License6pt0

No license detected.

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

Contributing guide5pt78

Contributing guide is too short for full depth credit (−6 pts). 400+ words earns the full +12 pts.

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

README12pt85

README is present.

Install and run instructions9pt90

README documents how to install the project.

Engineering

26

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 RuboCop config found.

→ Add a .rubocop.yml and run `rubocop` in CI to enforce consistent Ruby 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/engineering_blogs.yml).

Reproducibility6pt80

Lockfile present (Gemfile.lock). Installs are reproducible.

Project health

73

Activity5pt20

No pushes in over a year (−80 pts).

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

Housekeeping3pt60

.gitignore present.

Dependency manifest6pt100

Dependency manifest found (Gemfile).

Repository metadata5pt100

Repository has a description.

Repository files10 root entries
  • .github
    Good: CI is configured (.github/workflows/engineering_blogs.yml).
  • .DS_Store
    Issue: Build artifacts or local files may be committed (.DS_Store) (−40 pts).Fix: Remove them and add to .gitignore.
  • .gitignore
    Good: .gitignore present.
  • .ruby-version
    Good: Environment pinned via .ruby-version.
  • contributing.md
    Issue: Contributing guide is too short for full depth credit (−6 pts). 400+ words earns the full +12 pts.Fix: Add setup instructions, code style notes, and how to run tests.
    Good: Contributing guide includes setup/install instructions.
    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).
    Good: Contributing guide describes the PR/review workflow.
    Good: Contributing guide includes code examples.
  • engineering_blogs.opml
  • Gemfile
    Good: Dependency manifest found (Gemfile).
  • Gemfile.lock
    Good: Lockfile present (Gemfile.lock). Installs are reproducible.
  • generate_opml.rb
  • README.md
    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.
    Good: README includes status badges.
    Good: README documents how to install the project.
    Good: README documents how to run the project.