A top-tier open source project. Docs, tests, and CI are all in excellent shape.

OpenProject is the leading open source project management software.

Documentation

79

Install and run instructions9pt55

README documents how to install the project.

README12pt85

README is present.

Contributing guide5pt85

Contributing guide is detailed and thorough.

License6pt100

Licensed under GPL-3.0.

Engineering

96

CI/CD14pt85

CI is configured (.github/workflows/test-core.yml).

Tests18pt100

Test files detected (extensions/op-blocknote-hocuspocus/test).

Linting and formatting5pt100

Linter or formatter configured (.editorconfig).

Reproducibility6pt100

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

Issue and PR templates6pt100

Issue or PR templates present.

Project health

79

Dependency manifest6pt55

Dependency manifest found (Gemfile).

Housekeeping3pt60

.gitignore present.

Repository metadata5pt100

Repository has a description.

Activity5pt100

Actively maintained (pushed within the last month).

Repository files74 root entries
  • .erb_linters
  • .github
    Good: CI is configured (.github/workflows/test-core.yml).
    Good: Dependabot covers 4 ecosystems (npm, bundler, npm, github-actions). Dependencies stay current.
    Good: Issue or PR templates present.
  • .redocly
  • app
  • bin
  • config
  • db
  • docker
    Issue: Build artifacts or local files may be committed (docker/dev/jira-software/.env) (−40 pts).Fix: Remove them and add to .gitignore.
  • docs
  • extensions
    Good: Test files detected (extensions/op-blocknote-hocuspocus/test).
  • extra
  • files
  • frontend
  • help
  • lib
  • lib_static
  • log
  • lookbook
  • modules
  • nix
  • packaging
  • public
  • screenshots
  • script
  • spec
  • tmp
  • vendor
  • vendored-plugins
  • .buildpacks
  • .dockerignore
  • .editorconfig
    Good: Linter or formatter configured (.editorconfig).
  • .env.example
  • .env.test.local.example
  • .erb_lint.yml
  • .git-blame-ignore-revs
  • .gitignore
    Good: .gitignore present.
  • .jshintignore
  • .openproject-token.pub
  • .pkgr.yml
  • .redocly.lint-ignore.yaml
  • .redocly.yaml
  • .rspec_parallel
  • .rubocop.yml
  • .ruby-version
  • .yamllint.yml
  • AGENTS.md
  • CHANGELOG.md
  • CLAUDE.md
  • CODE_OF_CONDUCT.md
    Good: Code of conduct present.
  • config.ru
  • CONTRIBUTING.md
    Good: Contributing guide is detailed and thorough.
    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.
    Good: Contributing guide explains how to run tests.
    Good: Contributing guide describes the PR/review workflow.
    Good: Contributing guide includes code examples.
  • COPYRIGHT
  • COPYRIGHT_short
  • crowdin.yml
  • Dangerfile
  • docker-compose.ci.yml
  • docker-compose.override.example.yml
  • docker-compose.yml
    Good: Environment pinned via docker-compose.yml.
  • Gemfile
    Good: Dependency manifest found (Gemfile).
  • Gemfile.lock
    Good: Lockfile present (Gemfile.lock). Installs are reproducible.
  • Gemfile.modules
  • GitHub-tab-new.png
  • Guardfile
  • lefthook.yml
  • LICENSE
    Good: Licensed under GPL-3.0.
  • package-lock.json
  • package.json
  • Procfile
  • Procfile.dev
  • publiccode_logo.svg
  • publiccode.yml
  • Rakefile
  • 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.
    Issue: No run or usage instructions found (−45 pts).Fix: Add a section showing how to start or use the project.
  • SECURITY.md
    Good: Security policy present.