fluent/fluentd

0

/ 100

Documentation85
Engineering83
Health100
Ruby13,548Apache-2.05d ago
Grade a repo

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

Fluentd: Unified Logging Layer (project under CNCF)

Documentation

85

Contributing guide5pt61

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.

License6pt100

Licensed under Apache-2.0.

Engineering

83

Reproducibility6pt20

No dependency lockfile found (−70 pts).

→ Commit Gemfile.lock so Bundler installs are repeatable.

Tests18pt80

Test files detected (lib/fluent/test).

CI/CD14pt100

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

Linting and formatting5pt100

Ruby linting configured (.rubocop.yml).

Issue and PR templates6pt100

Issue or PR templates present.

Project health

100

Dependency manifest6pt100

Dependency manifest found (Gemfile).

Repository metadata5pt100

Repository has a description.

Activity5pt100

Actively maintained (pushed within the last month).

Housekeeping3pt100

.gitignore present.

Repository files25 root entries
  • .github
    Good: CI is configured (.github/workflows/test-ruby-head.yml).
    Good: Dependabot covers 2 ecosystems (github-actions, github-actions). Dependencies stay current.
    Good: Issue or PR templates present.
  • bin
  • docs
  • example
  • lib
    Good: Test files detected (lib/fluent/test).
  • tasks
  • templates
  • test
  • .gitignore
    Good: .gitignore present.
  • .rubocop.yml
    Good: Ruby linting configured (.rubocop.yml).
  • ADOPTERS.md
  • AUTHORS
  • CHANGELOG.md
  • code-of-conduct.md
  • 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).
    Good: Contributing guide describes the PR/review workflow.
    Issue: Contributing guide has no code examples (−5 pts).Fix: Add code blocks showing example commands for setup, running tests, and submitting a PR.
  • fluent.conf
  • fluentd.gemspec
  • Gemfile
    Good: Dependency manifest found (Gemfile).
  • GithubWorkflow.md
  • GOVERNANCE.md
  • LICENSE
    Good: Licensed under Apache-2.0.
  • MAINTAINERS.md
  • 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.
    Good: README documents how to run the project.
  • SECURITY.md
    Good: Security policy present.