redmine/redmine: Grade D (61/100)

/ 100

Ruby5,961Other5d ago

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

Mirror of redmine code source - Official Subversion repository is at https://svn.redmine.org/redmine - contact: @vividtone or maeda (at) farend (dot) jp

Documentation

3 checks need work

Install and run instructions9pt

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

→ Add a section showing how to install dependencies.

README12pt

README is present.

Contributing guide5pt

CONTRIBUTING guide is very brief (−12 pts for depth). 150+ words earns +6 pts; 400+ earns +12 pts.

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

License6pt

100

Licensed under Other.

Engineering

2 checks need work

Issue and PR templates6pt

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

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

Reproducibility6pt

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

Tests18pt

Test files detected (extra/sample_plugin/test).

Linting and formatting5pt

100

Ruby linting configured (.rubocop.yml).

Project health

100

0 checks need work

Dependency manifest6pt

100

Dependency manifest found (Gemfile).

Repository metadata5pt

100

Repository has a description.

Activity5pt

100

Actively maintained (pushed within the last month).

Housekeeping3pt

100

.gitignore present.

Repository files29 root entries

.github
Good: CI is configured (.github/workflows/linters.yml).
app
bin
config
db
doc
extra
Good: Test files detected (extra/sample_plugin/test).
files
lib
log
plugins
public
test
themes
tmp
vendor
.gitignore
Good: .gitignore present.
.rubocop_todo.yml
.rubocop.yml
Good: Ruby linting configured (.rubocop.yml).
.stylelintignore
.stylelintrc
config.ru
CONTRIBUTING.md
Issue: CONTRIBUTING guide is very brief (−12 pts for depth). 150+ words earns +6 pts; 400+ earns +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.
Gemfile
Good: Dependency manifest found (Gemfile).
LICENSE.txt
Good: Licensed under Other.
package.json
Rakefile
README.rdoc
Good: README is present.
Issue: README is very short (−20 pts). 400+ characters earns +10 pts; 1,500+ earns +20 pts.Fix: Add an Overview, Install, Usage, and Contributing section at minimum.
Issue: README has little structure (−15 pts). Add 2-3 headings for +8 pts; 4+ earns +15 pts.Fix: Break it into sections (Overview, Install, Usage, Contributing) using Markdown headings.
Issue: No screenshots or images in the README (−20 pts).Fix: Add a GIF, screenshot, or logo image. It is the fastest way to show what your project does.
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.
yarn.lock
Good: Lockfile present (yarn.lock). Installs are reproducible.