Ship LICENSE.md in package and add SECURITY.md#133
Merged
Conversation
There was a problem hiding this comment.
Pull request overview
This PR improves package/distribution metadata and security reporting guidance by ensuring the project’s license file is explicitly included in the published npm tarball and by adding a GitHub-native security policy document.
Changes:
- Add
LICENSE.mdtopackage.json#filesso it’s included in the published package (improves SBOM/license detection). - Add
SECURITY.mdwith instructions to report vulnerabilities via GitHub private vulnerability reporting.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
SECURITY.md |
Adds a security policy and private vulnerability reporting link. |
package.json |
Explicitly includes LICENSE.md in the npm publish whitelist. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Add LICENSE.md to the package.json `files` array so SBOM tooling can detect the license in the published tarball (closes #128). - Add SECURITY.md pointing to GitHub's private vulnerability reporting form for responsible disclosure (closes #108). Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
b813858 to
0588955
Compare
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #133 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 41 41
Lines 622 622
Branches 115 140 +25
=========================================
Hits 622 622 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
|
Size Change: 0 B Total Size: 11.5 kB ℹ️ View Unchanged
|
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.
Summary
LICENSE.mdto thefilesarray inpackage.jsonso it's explicitly included in the published tarball — helps SBOM tooling detect the license. Closes Missing LICENSE.md file on shipped package #128.SECURITY.mdpointing to GitHub's private vulnerability reporting form for responsible disclosure. Closes Create SECURITY.md #108.Test plan
npm pack --dry-runlistsLICENSE.mdin the tarball contentsSECURITY.mdrenders on the repo's Security tab and the "Report a vulnerability" link resolves🤖 Generated with Claude Code