thoughtbot/guides

0

/ 100

Documentation37
Engineering49
Health94
Ruby9,5579d ago
Grade a repo

Strong community interest, but tests, CI, or docs need work.

A guide for programming in style.

Documentation

37

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 guide5pt58

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.

README12pt75

README is present.

Engineering

49

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.

Tests18pt35

Test files detected (testing-rspec/acceptance_test_spec.rb).

CI/CD14pt57

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

Reproducibility6pt80

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

Linting and formatting5pt100

Linter or formatter configured (javascript-typescript/.eslintrc.json).

Project health

94

Dependency manifest6pt82

Dependency manifest found (package.json).

Repository metadata5pt100

Repository has a description.

Activity5pt100

Actively maintained (pushed within the last month).

Housekeeping3pt100

.gitignore present.

Repository files46 root entries
  • _template
  • .github
    Good: CI is configured (.github/workflows/linting.yml).
  • accessibility
  • android
  • bash
  • code-review
  • css
  • data
  • email
  • erb
  • general
  • git
  • graphql
  • html
  • ios
  • javascript-typescript
    Good: Linter or formatter configured (javascript-typescript/.eslintrc.json).
  • object-oriented-design
  • open-source
  • postgres
  • product-review
  • python
  • rails
    Good: Security policy present.
  • react
  • react-native
  • relational-databases
  • ruby
  • sass
  • security
  • shell
  • swift
  • tech-stack
  • testing-jest
  • testing-rspec
    Good: Test files detected (testing-rspec/acceptance_test_spec.rb).
  • web
  • web-performance
  • .gitignore
    Good: .gitignore present.
  • .hound.yml
  • .markdownlint-cli2.jsonc
  • .tool-versions
    Good: Environment pinned via .tool-versions.
  • CODE_OF_CONDUCT.md
    Good: Code of conduct present.
  • 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.
    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.
  • lefthook.yml
  • mise.toml
  • package-lock.json
    Good: Lockfile present (package-lock.json). Installs are reproducible.
  • package.json
    Good: Dependency manifest found (package.json).
  • 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.
    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.