chore(community): improve open-source readiness - #30
Merged
Conversation
Add current community health files, private security reporting guidance, grouped dependency updates, and a pinned OpenSSF Scorecard workflow. Correct public documentation links and Maven coordinates, and update CI actions to Node 24-based releases. Co-Authored-By: Dhiman's Agentic Suite <dhiman.seal@hotmail.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Why
The repository's community profile is 71%, has no Code of Conduct or pull request template, and
does not provide a private vulnerability-reporting policy. Its README also links to a nonexistent
license path, calls the GPL-3.0 license LGPL, and shows the wrong Maven group ID. The current CI
action pins emit Node 20 deprecation warnings, and there is no version-update configuration or
published OpenSSF Scorecard result.
Changes
templates.
Test plan
mvn --batch-mode --no-transfer-progress -Dgpg.skip=true clean verify: 25 tests passed andthe JAR, sources, and Javadocs built.
actionlint: both workflows passed..github/**/*.ymlfile with a YAML parser.markdownlint-cli2: README, community files, and templates passed with zero errors.markdown-link-check: README and contributing guide passed with zero dead links.gitleaks detect --no-git --source .: no secrets found.git diff --check: no whitespace errors.Trade-offs
The Contributor Covenant and security policy add process, not runtime behavior. Dependabot may open
grouped maintenance pull requests each week, capped at five Maven pull requests; this is intentional
to prevent the unmanaged backlog that caused the security migration. Scorecard findings will be
visible in code scanning, but they are evidence to triage rather than automatic proof that source
code is vulnerable. No production or test source changed.
How to review
.github/workflows/scorecard.ymland.github/dependabot.ymlfor least privilege,immutable action pins, schedule, and bounded update grouping.
SECURITY.md,CODE_OF_CONDUCT.md, and.github/PULL_REQUEST_TEMPLATE.mdfor practicalreporting and contribution guidance without promises a volunteer maintainer cannot keep.
README.mdandCONTRIBUTING.mdfor the corrected GPL-3.0 path, Maven coordinates,Java 17 baseline, and link integrity.
.github/ISSUE_TEMPLATE/to confirm bug reports collect library-specific reproductionevidence and route security reports privately.