Problem to Fix
The project is missing standard GitHub community health files and has minor CI configuration warnings. Specifically: no security policy exists, workflow files trigger CodeQL warnings about unrestricted token permissions, and the README layout doesn't match modern open-source presentation standards.
Why it Matters
First impressions matter for open-source adoption. A polished GitHub presence — with a security policy, clean CI, and an inviting README — signals a well-maintained project and builds contributor confidence.
General Approach
- Add a lightweight SECURITY.md with a simple disclosure policy via GitHub Issues (appropriate for a low-risk developer tool with no user data)
- Add explicit
permissions: { contents: read } blocks to both CI workflows to resolve CodeQL warnings
- Restructure the README with a centered header, tagline, badge row (including a new CodeQL badge), and hero image — followed by the existing content
- Keep all existing badge links and documentation structure intact
Complexity
Verification / QA effort: moderate
Four files are touched but changes are cosmetic/config — verify the README renders correctly on GitHub and CI workflows still pass.
Acceptance Criteria
- SECURITY.md exists at the repo root with a clear reporting process and supported-versions table
- Both workflow files include explicit permissions blocks and CodeQL warnings are resolved
- README opens with a centered title, tagline, badges (including CodeQL), and header image
- All existing README content (problem statement, quick start, docs links, license) is preserved
- CI workflows continue to pass after the permissions change
Problem to Fix
The project is missing standard GitHub community health files and has minor CI configuration warnings. Specifically: no security policy exists, workflow files trigger CodeQL warnings about unrestricted token permissions, and the README layout doesn't match modern open-source presentation standards.
Why it Matters
First impressions matter for open-source adoption. A polished GitHub presence — with a security policy, clean CI, and an inviting README — signals a well-maintained project and builds contributor confidence.
General Approach
permissions: { contents: read }blocks to both CI workflows to resolve CodeQL warningsComplexity
Verification / QA effort: moderate
Four files are touched but changes are cosmetic/config — verify the README renders correctly on GitHub and CI workflows still pass.
Acceptance Criteria