opensearch-project/security

0

/ 100

Documentation91
Engineering79
Health100
Java242Apache-2.01d ago
Grade a repo

Polished and well engineered. Punching above its star count.

🔐 Secure your cluster with TLS, numerous authentication backends, data masking, audit logging as well as role-based access control on indices, documents, and fields

Documentation

91

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.

Install and run instructions9pt90

README documents how to install the project.

README12pt100

README is present.

License6pt100

Licensed under Apache-2.0.

Engineering

79

Reproducibility6pt20

No dependency lockfile found (−70 pts).

→ Commit the lockfile for this project's package manager so installs produce the same dependency versions everywhere.

Tests18pt80

Test files detected (bwc-test/src/test).

CI/CD14pt85

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

Linting and formatting5pt100

Java/Kotlin linting configured (checkstyle/checkstyle.xml).

Issue and PR templates6pt100

Issue or PR templates present.

Project health

100

Dependency manifest6pt100

Dependency manifest found (build.gradle).

Repository metadata5pt100

Repository has a description.

Activity5pt100

Actively maintained (pushed within the last month).

Housekeeping3pt100

.gitignore present.

Repository health signals

Activity, community, and responsiveness at scan time

Activity

  • —
    Commits (30d / 90d)
  • 378
    Forks
  • 77
    Releaseslatest 6y ago

Community

  • —
    Community health
  • —
    authors own >50% of commits
  • 242
    Watchers

Responsiveness

  • 3d 3h
    Median issue response
  • 22h
    Median PR merge time
  • 338
    Open issues
Repository files44 root entries
  • .github
    Good: CI is configured (.github/workflows/ci.yml).
    Good: Dependabot covers 3 ecosystems (gradle, gradle, github-actions). Dependencies stay current.
    Good: Issue or PR templates present.
  • bwc-test
    Good: Test files detected (bwc-test/src/test).
  • checkstyle
    Good: Java/Kotlin linting configured (checkstyle/checkstyle.xml).
  • config
  • formatter
  • gradle
  • libs
  • release-notes
  • sample-resource-plugin
  • scripts
  • spi
  • src
  • tools
  • .gitattributes
  • .gitignore
    Good: .gitignore present.
  • .linelint.yml
  • .lycheeignore
  • .whitesource
  • ADMINS.md
  • AGENTS.md
  • ARCHITECTURE.md
  • build.gradle
    Good: Dependency manifest found (build.gradle).
  • CHANGELOG.md
  • check-permissions-order.js
  • CODE_OF_CONDUCT.md
    Good: Code of conduct present.
  • codecov.yml
  • 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.
  • DEVELOPER_GUIDE.md
  • DEVELOPING_WITH_DOCKER.md
  • gradle.properties
  • gradlew
  • gradlew.bat
  • LICENSE.txt
    Good: Licensed under Apache-2.0.
  • MAINTAINERS.md
  • NOTICE.txt
  • plugin-security.policy
  • README.md
    Good: README is present.
    Good: README is well structured with multiple sections.
    Good: README includes screenshots or visuals. Great for first impressions.
    Good: README has code examples.
    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.
  • RELEASING.md
  • RESOURCE_SHARING_AND_ACCESS_CONTROL.md
  • REST_AUTHZ_FOR_PLUGINS.md
  • SECURITY.md
    Good: Security policy present.
  • settings.gradle
  • spotbugs-include.xml
  • TRIAGING.md