64
/ 100
A workable base with real gaps. Start with CI and issue and PR templates.
Setup instructions for Le Wagon's students on their first day of AI Software Development Bootcamp
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 B (83).
See your top fixesTop fixes
Highest-impact changes first, ranked by point weight
- 1Tests18pt
Wire your tests to a documented command (e.g. a test script in your build config) so the suite is reproducible.
- 2CI/CD14pt
Add a step like `run: npm test`, `run: pytest`, or `run: tox` to your workflow file.
- 3CI/CD14pt
Add `pull_request:` to the workflow `on:` triggers.
- 4CI/CD14pt
Add a lint step to catch style issues automatically.
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
56
No CONTRIBUTING.md found (−47 pts base + up to −53 pts more for content).
→ Add a CONTRIBUTING.md telling newcomers how to get involved. Include setup, code style, test, and PR instructions.
README documents how to install the project.
README is present.
A license file is present.
Engineering
61
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 (.github/workflows/build.yml).
Test files detected (lib/build_spec.rb).
Lockfile present (Gemfile.lock). Installs are reproducible.
Ruby linting configured (.rubocop.yml).
Project health
100
Dependency manifest found (Gemfile).
Repository has a description.
Actively maintained (pushed within the last month).
.gitignore present.
Repository health signals
Activity, community, and responsiveness at scan time
Activity
- 0 / 0Commits (30d / 90d)
- 1,576Forks
- 0Releases
Community
- 50% - FairCommunity health
- 3 bus factorauthors own >50% of commits
- 19,618Watchers
Responsiveness
- 62d 20hMedian issue response
- 4hMedian PR merge time
- 3Open issues
Repository files37 root entries
- _partials
- .githubGood: CI is configured (.github/workflows/build.yml).
- builds
- constants
- doc
- docs
- images
- libGood: Test files detected (lib/build_spec.rb).
- utils
- .gitignoreGood: .gitignore present.
- .rubocop.ymlGood: Ruby linting configured (.rubocop.yml).
- .ruby-versionGood: Environment pinned via .ruby-version.
- build.rb
- check.rb
- GemfileGood: Dependency manifest found (Gemfile).
- Gemfile.lockGood: Lockfile present (Gemfile.lock). Installs are reproducible.
- LICENSEGood: A license file is present.
- macos.cn.md
- macos.es.md
- macos.fr.md
- macos.md
- macos.pt.md
- README.cn.mdGood: README is present.Issue: README is fairly short (−10 pts). At 400+ chars you get partial credit; 1,500+ earns the full +20 pts.Fix: Expand with a description, install steps, usage, and examples.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.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.
- README.es.md
- README.fr.md
- README.md
- README.pt.md
- ubuntu.cn.md
- ubuntu.es.md
- ubuntu.fr.md
- ubuntu.md
- ubuntu.pt.md
- windows.cn.md
- windows.es.md
- windows.fr.md
- windows.md
- windows.pt.md
Add this badge to your README
It updates automatically each time the repo is re-graded.
[](https://www.repo-grade.com/report/lewagon/setup)